put
https://{Host}/api_gateway/v1/promotions//activate
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
You can use this API to activate a promotion at the organisation level.
- When you activate a promotion globally, the system makes it eligible for evaluation during cart processing. The promotion applies to all eligible customers based on its configuration and targeting rules.
- Use this API when you are ready to move a configured promotion from an inactive state to an active state across the organisation.
- If you need to activate a promotion only for a specific customer, use the Activate Promotion for Customer API instead.
- Activate a promotion only after you complete its configuration, including rules, rewards, validity, and targeting.
Example request
curl --location --request PUT 'https://{Host}/api_gateway/v1/promotions/{Promotionid}/activate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=JTn6J5w_XI6I59i2lJMz39zEaGAvDWdREw-1770697785684-0.0.1.1-604800000'Prerequisites
- Authentication: Basic or OAuth authentication.
- Default access group
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
| promotionId | String | Yes | The unique identifier of the promotion to be activated globally. |
Example response
{
"data": true,
"errors": []
}Response parameters
| Field | Type | Description |
|---|---|---|
| data | Boolean | Returns true if the global activation was successful. |
| errors | Array | A list of error objects (empty on success). |
Error codes
| Code | Description |
|---|---|
| 400 | GLOBAL.INVALID_INPUT: Malformed request or invalid promotionId format. |
| 404 | GLOBAL.PROMOTION_NOT_FOUND: The promotion configuration was not found for the given organization. |
| 705 | PROMO.MAX_ACTIVE_PROMOTION_EXCEEDED: The organization has reached the maximum number of simultaneous active promotions allowed by its subscription. |
| 725 | PROMO.PROMOTION_ID_INVALID: The provided ID is not a valid format. |
| 744 | PROMO.DUPLICATE_PROMOTION_NAME: Another active promotion with the same name already exists in the organization. |
| 811 | PROMO.UPDATE_EXPIRY_DATE_NOT_ALLOWED: Status change is blocked because an expiry date update job is currently running on this promotion. |
| 500 | GLOBAL.UNEXPECTED_ERROR: Internal server error. |
