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

Example request

curl --location 'https://eu.api.capillarytech.com/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	Object	Defines an object containing the activation details. (Note: Example shows boolean true on simple success).
..promotionId	String	Specifies the ID of the promotion that was activated.
..customerId	Number	Specifies the customer for whom the promotion was activated.
..status	String	Specifies the result of the activation
..earnId	String	Specifies the earn ID it was linked to, if provided.
errors	Array	Defines a list of error objects, if any.