Process dynamic offer decisions

The Dynamic Offer Decision Engine can be invoked via the Public API to calculate a decision output response based upon each property rule under the Dynamic Offer created in the Zephr Console.

Request

Request Body schema: application/json

required	object The dynamic offer to evaluate, must specify the slug of the dynamic offer, and any custom input to be used in the rules
session	string Zephr Session ID, required for trials
foreign_keys	object Foreign system and ID used to identify the user
ip	string Client IP address, defaults to request IP
user_agent	string Client user agent
jwt	string A Json Web Token, may include identity or product holding claims
path	string Request path, required for trials if used

Responses

200

400

Bad Request

post/zephr/public/decisions/v2/dynamic-offers

Request samples

Payload

application/json

{"dynamic_offer": {"slug": "offerX",
"inputs": { }
},
"session": "xxx-xxx-xxx",
"foreign_keys": { },
"ip": "x.x.x.x",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11)...",
"jwt": "xxx-xxx-xxx",
"path": "/x.html"
}

Response samples

application/json

{"products": [{"id": "string",
"label": "string",
"description": "string",
"features": [{"id": "string",
"label": "string",
"description": "string",
"type": "string"
}
],
"sharingLimit": 0,
"metadata": {"order": 0,
"recommended": true
},
"paymentPlans": [{"planId": "string",
"planData": { },
"charges": [{"chargeId": "string",
"prices": [{ }
],
"chargeDefinitionData": { },
"chargeData": { },
"discounts": [null
]
}
]
}
],
"attributes": { }
}
],
"tagline": "string",
"custom": { },
"outcomes": [ ],
"errors": [{"property": "string",
"error": "string"
}
]
}