Activates a specific promotion for a customer, optionally linking it to a specific earn ID..

Example request

curl --location 'https://{Host}/api_gateway/v1/promotions/68fb1e6831d91c625a8d9ef4/activate?customerId=567205858' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmJ1a2w6OGFmND3YzI4ZjU4ZjY3MmNhZjY1ZmY=' \
--header 'Cookie: _cfuvid=DWAI.W93CwD8HSqqi338lKP84bJoUrRqwVps-1761979737913-0.0.1.1-604800000' \
--data '
{
  "customerId": "566881933",
  "earnId": "1234123"
}
'

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

Rate limit

Demo and Testing Clusters: 1,000 requests per minute per API key
Other Organizations: The rate limit is brand-specific.

To modify the limit, create a ticket with the Capillary Product support team.

Path parameters

Field	Type	Required	Description
promotionId	String	Yes	Specifies the unique identifier for the promotion to be activated.

Query parameters

Field	Type	Required	Description
customerId	Number	Yes	Specifies the unique identifier for the customer.

Body parameters

Field	Type	Required	Description
customerId	String	Optional	Specifies the customer's ID.
earnId	String	Optional	Specifies the specific earn ID to link the activation to.

Example response

{
    "data": true,
    "errors": []
}

Response parameters

Field	Type	Description
data	Boolean	Indicates the success status of the operation. true means it was successful.
errors	Array	Defines a list of error objects. Indicates it will be empty on success.

Error codes

Code	Description
400	Invalid request. Check required parameters. Ensure all required parameters, including a valid `promotionId`, are provided and valid.
404	Promotion not found. Use a valid and existing `promotionId`.
705	Exceeded maximum active promotions for an org. Deactivate some active promotions before activating a new one.
706	Promotion has expired. Use a valid, non-expired promotion for the activation operation.
707	The passed promotion type is not supported. Change the promotion type to one supported by the system.
713	Earned from type cannot be changed. Do not change `earnedFromType` on existing earned promotions.
714	Earn is not supported for this promotion type. Switch to a supported promotion type for earn operations.
716	Promotion name must be unique. Use an unused, unique promotion name.
500	Internal server error. Retry the request after a short delay, and contact support if the error persists.