Offers

Supported Formats

application/json
>>>

Supported Formats

application/json

Path Parameters

integration_id
string
required

The ID of the integration

  • Must be a String

flow_id
string
required

The ID of the flow

  • Must be a String

id
string
required

The ID of the offer

  • Must be a String

Query Parameters

placement
string
required

The placement context where the offer will be displayed (e.g., order_confirmation, order_status)

  • Must be a String

first_name
string
optional

The first name of the user for personalization

  • Must be a String

Returns

Response - Offer created

Code 201 - application/json
api_version
string
required

The API version

  • Must be a String

data
array
required

This will return up to two main items. The first item will be the offer and the second item will be the event. The offer is made up of segments and each segment may contain children.

[
  {
    "type": "event",
    "id": "...",
    "children": [
      {
        "type":"text"
      },
      {
        "type":"view",
        "children": [{"type":"text"}]
      }
    ]
  },
  {
    "type": "event"
  }
]

Possible segment types are:

  • Must be an array of any type

links
array
required

  • Must be an Array of nested elements

Response - No offers found

Code 202 - application/json
data
array
required

It will be empty

  • Must be an array of any type

Response - Unable to find the integration

Code 404 - application/json
errors
array
required

  • Must be an Array of nested elements

Response - The site is blocked

Code 403 - application/json
errors
array
required

  • Must be an Array of nested elements

Response - Unable to find the placement

Code 422 - application/json
errors
array
required

  • Must be an Array of nested elements

>>>

Supported Formats

application/json

Path Parameters

integration_id
string
required

The ID of the integration

  • Must be a String

flow_id
string
required

The ID of the flow

  • Must be a String

id
string
required

The ID of the offer

  • Must be a String

Returns

Response - Offer shown

Code - application/json
api_version
string
required

The API version

  • Must be a String

data
array
required

This will return up to two main items. The first item will be the offer and the second item will be the event. The offer is made up of segments and each segment may contain children.

[
  {
    "type": "event",
    "id": "...",
    "children": [
      {
        "type":"text"
      },
      {
        "type":"view",
        "children": [{"type":"text"}]
      }
    ]
  },
  {
    "type": "event"
  }
]

Possible segment types are:

  • Must be an array of any type

links
array
required

  • Must be an Array of nested elements