Add or Deduct Points

POST/members/{externalId}/points

Award points to a member (positive amount) or deduct points (negative amount)

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

externalId*string

Request Body

application/json

amount*integer

Points to add (positive) or deduct (negative)

description?string

referenceId?string

Link to related entity (quest, order, etc.)

metadata?object

Response Body

`application/json`

curl -X POST "https://app.useloyalty.app/api/v1/members/string/points" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100,
    "description": "Completed profile setup"
  }'

curl -X POST "https://app.useloyalty.app/api/v1/members/string/points" \  -H "Content-Type: application/json" \  -d '{    "amount": 100,    "description": "Completed profile setup"  }'

{
  "transaction": {
    "id": "string",
    "amount": 0,
    "balance": 0,
    "type": "EARNED",
    "description": "string",
    "referenceId": "string",
    "createdAt": "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