DEVELOPERS · API v1

Stamps

Public documentation. Partner access through Sales.

Contact Sales

Documentation / Stamps

Award one stamp after a qualifying event, or remove one existing stamp. Reaching the threshold creates one available reward and resets the stamp progress by that threshold.

Endpoint

POST /api/partner/v1/stamps
Scope: stamps:write
Idempotency-Key: required
Success: 200

Request fields

FieldRequiredFormat
member_idrequiredmem_{id}, string ≤ 24
countrequired1 or -1
reasonrequiredstring ≤ 60
source_refrequiredstring ≤ 100

Request body

{"member_id":"mem_123","count":1,"reason":"appointment.completed","source_ref":"visit_100"}

Success response

{"member_id":"mem_123","balance":3,"stamps_added":1,"rewards_available":0,"reward_unlocked":false}

Source references and reversals

Reuse source_ref when retrying the same action for the same member. A new header key with the same source does not award again and reports stamps_added: 0. Removing a stamp requires an existing stamp; it does not cancel an already earned reward. Suspended businesses reject new stamps.

Your privacy

We use necessary storage for sign-in, security and preferences. No analytics or advertising trackers are enabled.

Necessary storage Always active
Keeps your session secure, remembers your language and stores your privacy choice.
Analytics and advertising
Not enabled. We do not use session replay or advertising cookies in this version.

This choice does not accept subscription terms or sign you up for marketing emails.

Legal and privacy centre