Promotions

Endpoint to return all promoted rewards for a program using the current JWT

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

Successful response

application/json

get

/v2/admin/promotions

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/promotions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "promotions": [
    "text"
  ]
}

Endpoint to create a promotion.

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/x-www-form-urlencoded

start_datenumberRequired

When the promotion becomes active, in epoch seconds.

titlestringRequired

Title of the promotion.

descriptionstringOptional

Description of the reward.

end_datenumberOptional

When the promotion is no longer active, in epoch seconds.

image_urlstringOptional

URL of the promotion image.

Responses

200

Successful response

application/json

post

/v2/admin/promotions

HTTPcURLJavaScriptPython

POST /partner-api/v2/admin/promotions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 84

"start_date=1&title='text'&description='text'&end_date=1&image_url='text'"

200

Successful response

{
  "promotion": {
    "id": "text",
    "title": "text",
    "description": "text",
    "reward_id": 1,
    "start_date": 1,
    "end_date": 1
  }
}

Endpoint to update a promotion.

patch

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

promotion_idnumberRequired

Body

application/x-www-form-urlencoded

start_datenumberRequired

When the promotion becomes active, in epoch seconds.

titlestringRequired

Title of the promotion.

descriptionstringOptional

Description of the reward.

end_datenumberOptional

When the promotion is no longer active, in epoch seconds.

image_urlstringOptional

URL of the promotion image.

Responses

200

Successful response

application/json

patch

/v2/admin/promotions/{promotion_id}

HTTPcURLJavaScriptPython

PATCH /partner-api/v2/admin/promotions/{promotion_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 84

"start_date=1&title='text'&description='text'&end_date=1&image_url='text'"

200

Successful response

{
  "promotion": {
    "id": "text",
    "title": "text",
    "description": "text",
    "reward_id": 1,
    "start_date": 1,
    "end_date": 1
  }
}