POST
/
referrals
/
redeem
Redeem a referral code
curl --request POST \
  --url https://api.useautumn.com/v1/referrals/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "<string>",
  "customer_id": "<string>"
}'
{
  "id": "<string>",
  "customer_id": "<string>",
  "reward_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
code
string
required

The referral code to redeem

​
customer_id
string
required

The unique identifier of the customer redeeming the code

Response

200 - application/json

Referral code redeemed successfully

​
id
string

The ID of the redemption event

​
customer_id
string

Your unique identifier for the customer

​
reward_id
string

The ID of the reward that will be granted