Loyalty Progress Update API

Overview

Updates the stamp / points count on a loyalty member's pass. This is the operation behind the scan-to-check-in QR code: scanning a member's pass opens a check-in screen that calls this endpoint. The pass artwork re-renders to the image for the new count, an optional push notification is sent, and the change is written to the Activity Log.

Path Parameters

• customerId (string, required): The member to check in. This is the customerId returned by Add User and listed by List Users.

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request Body

The body is optional. With no body, the check-in simply increments the member's count by +1.

Request Example

A plain check-in — the server reads the current count and bumps it by +1 (e.g. 2 → 3):

curl -X PUT 'https://app.addtowallet.co/api/loyalty-pass/check-in/686d10e7c2f0bc5cdf25c84b' \
  -H 'apikey: your-api-key-here' \
  -H 'Content-Type: application/json' \
  -d '{
  "notificationData": {
    "heading": "Thanks for visiting!",
    "body": "One stamp closer to your reward."
  }
}'

Set an exact count instead with updatedCount:

curl -X PUT 'https://app.addtowallet.co/api/loyalty-pass/check-in/686d10e7c2f0bc5cdf25c84b' \
  -H 'apikey: your-api-key-here' \
  -H 'Content-Type: application/json' \
  -d '{
  "updatedCount": 4
}'

Reset the card back to its initial count:

curl -X PUT 'https://app.addtowallet.co/api/loyalty-pass/check-in/686d10e7c2f0bc5cdf25c84b' \
  -H 'apikey: your-api-key-here' \
  -H 'Content-Type: application/json' \
  -d '{
  "resetVisits": true
}'

Response

On success the API confirms the update. The wallet pass is re-rendered with the image for the new count, and a visit entry is added to the activity log.

Response Example

{
  "message": "Updated pass successfully",
  "previousCount": 2,
  "updatedCount": 3
}