useLoyalty
Api reference

Create or Update Member

Creates a new member or updates an existing one (upsert behavior)

POST/members

Creates a new member or updates an existing one (upsert behavior)

AuthorizationBearer <token>

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

In: header

Request Body

application/json

externalId*string

Your unique identifier for this user

email?string
Formatemail
name?string
avatarUrl?string
Formaturi
phone?string
dateOfBirth?string
Formatdate
metadata?

Response Body

application/json

application/json

curl -X POST "https://app.useloyalty.app/api/v1/members" \  -H "Content-Type: application/json" \  -d '{    "externalId": "user_123",    "email": "john@example.com",    "name": "John Doe",    "metadata": {      "plan": "premium"    }  }'
{
  "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"
}
{
  "error": "string",
  "message": "string"
}
Empty