Claim a reward for a specific customer

post

https://api.staging.antavo.com/customers/{customer_id}/activities/rewards/{reward_id}/claim

This endpoint allows for claiming a reward for a customer.

Path Params

customer_id

string

required

Unique customer ID. This can be

reward_id

string

required

Unique reward ID.

Query Params

fields

string

enum

Returns additional objects in the response, using a comma separated list. Options:

customer: The complete customer response object with all customer attributes.
reward: The complete reward object with all reward attributes.

Allowed:

Form Data

A request body is only required for specific scenarios.

Dynamic rewards: The stated points are used to calculate the value of the generated dynamic coupon.
Making multiple claims in a single API request: Repeated identical reward claims can be combined into an single request, reducing API traffic.

points

integer

Points to be used when claiming a dynamic type of reward.

count

integer

The number of times that the reward is claimed in a single API request. This is only needed for multiple claims.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Claim result. A coupon object is returned only for coupon rewards.