Skip to main content
POST
https://api.pocketflows.com
/
track
Track when a user redeems their points
curl --request POST \
  --url https://api.pocketflows.com/track \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "user_id": "<string>",
  "location_id": "<string>",
  "rewards_program_id": "<string>",
  "location_member_id": "<string>",
  "member_id": "<string>",
  "points": 123
}
'
{
  "id": "<string>",
  "event_name": "<string>",
  "member": "<string>"
}

​
Parameters

​
event
string
default:"user.redeem"
required
Must be user.redeem
​
user_id
string
The ID of the user. Must be provided in conjunction with either location_id or rewards_program_id
​
location_id
string
The ID of the location where the redemption was made. Must be provided in conjunction with user_id
​
rewards_program_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
​
location_member_id
string
The ID of the location member. Can be used instead of a providing a pair of user_id and location_id
​
member_id
string
The ID of the rewards program member. Can be used instead of providing a pair of user_id and rewards_program_id.
​
points
integer
required
The number of points to redeem

​
Returns

​
id
string
The ID of the event
​
event_name
string
The name of the event that was captured
​
member
string