Skip to main content
POST
/
referrals
/
redeem
Redeem a referral code
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>', customer_id: '<string>'})
};

fetch('https://api.useautumn.com/v1/referrals/redeem', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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