Skip to main content
POST
Track when a user redeems their points

Parameters

string
default:"user.redeem"
required
Must be user.redeem
string
The ID of the user. Must be provided in conjunction with either location_id or rewards_program_id
string
The ID of the location where the redemption was made. Must be provided in conjunction with user_id
string
The ID of the rewards program that the user is redeeming under. Useful when redemptions are made at the brand level rather than in-store. Should not be simultaneously provided with location_id
string
The ID of the location member. Can be used instead of a providing a pair of user_id and location_id
string
The ID of the rewards program member. Can be used instead of providing a pair of user_id and rewards_program_id.
integer
required
The number of points to redeem

Returns

string
The ID of the event
string
The name of the event that was captured
string