Skip to main content

Activate promo code

Description

Activates a promo code.

caution

You can only activate a promotional code when it is attached to a profile.

Request URL

Method: POST

https://example.com/api/v1.1/promocodes/activate

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
codestring"CODE-12345"YesPromo code
formatint"json"NoResponse data format.
By default– json
loyalty_idint"1"YesLoyalty program ID

Request example

{
"code": "CODE-12345",
"loyalty_id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
"data": null,
"error": 0,
"error_text": "Successful operation"
}

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text