v1

latestOpenAPI 3.0.02026-08-0610682246.0 KB

Dynamic Offer Decision Engine

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.

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

Request body

sessionstring

Zephr Session ID, required for trials

foreign_keysobject

Foreign system and ID used to identify the user.

ipstring

Client IP address, defaults to request IP.

user_agentstring

Client user agent

jwtstring

A JSON Web Token, may include identity or product holding claims.

pathstring

Request path, required for trials if used.

content_idstring

Content ID, used to perform requests to a 3rd party API for additional content information used in making a decision.

Example request

{
  "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",
  "content_id": "xxx-xxx-xxx"
}

Response

taglinestring

The tagline rule output

customobject

key value pair of any custom property rule output. The key would be the property id, the value would be its rule output