Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

List promotions

Prev Next
Post
/list/promotion

Used to get summary information of promotions synced from connected bonus engines.


The List promotions endpoint can be used to obtain a list of promotions that are stored in Xtremepush from a sync with any bonus engine connected to your project. Promotion sync is done once an hour so there should be no need to query the `list/promotion` endpoint more frequently than that.

You can query with no parameters to see the full list of promotions and all related engines.

Body parameters
Pull promotions for a specific engine
{
  "apptoken": "YOUR-APP-TOKEN",
  "condition": [
    [
      "external_system",
      "=",
      "tglab"
    ]
  ],
  "select": [
    "id",
    "name",
    "external_id",
    "external_system"
  ],
  "limit": "1",
  "offset": "2"
}
object
apptoken
string Required

Your App token

limit
integer (int32)

Used with offset for pagination

offset
integer (int32)

Used with limit for pagination

Responses
200

200

Result
{
  "success": "True",
  "code": "200"
}
Expand All
object
success
boolean
Defaulttrue
ExampleTrue
code
integer
Default0
Example200
data
Array of object
object
400

400

Result
{
  "success": "False",
  "code": "400",
  "message": "General error information"
}
Expand All
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example400
message
string
ExampleGeneral error information
errors
Array of object
object
text
Array of string
string