useLoyalty
Api reference

Redeem Promo Code

Redeem a promotional code for points or a reward

POST/promo-codes/redeem

Redeem a promotional code for points or a reward

AuthorizationBearer <token>

Use your private API key (sk_xxx) as the bearer token

In: header

Request Body

application/json

externalId*string

Member's external ID

code*string

Promo code to redeem

Response Body

application/json

curl -X POST "https://app.useloyalty.app/api/v1/promo-codes/redeem" \  -H "Content-Type: application/json" \  -d '{    "externalId": "user_123",    "code": "SUMMER50"  }'
{
  "redemption": {
    "id": "string",
    "code": "string",
    "rewardType": "POINTS",
    "pointsAwarded": 0,
    "reward": {},
    "redeemedAt": "2019-08-24T14:15:22Z"
  },
  "member": {
    "id": "string",
    "externalId": "string",
    "email": "user@example.com",
    "name": "string",
    "avatarUrl": "http://example.com",
    "points": 0,
    "totalPointsEarned": 0,
    "currentStreak": 0,
    "longestStreak": 0,
    "metadata": {},
    "createdAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty