Rewards
Create or fetch a member by externalRef or customerId; 201 when created (scope: rewards:write)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
application/json- body
Exactly one of externalRef or customerId.
externalRef?stringLength
1 <= length <= 200customerId?stringAn end customer of your organization.
Format
uuidOK
application/json- response
data*error*nullcurl -X POST "https://example.com/rewards/members" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "ref": "string", "programKey": "string", "memberId": 0, "optedIn": true, "optedInAt": "2019-08-24T14:15:22Z", "holdout": true, "balance": { "available": 0, "pending": 0, "inDebt": true }, "level": { "level": 0, "xp": 0, "floor": 0, "next": 0, "ratio": 0 }, "streak": { "current": 0, "longest": 0, "freezes": 0, "atRisk": true, "currentPeriod": "string", "activeThisPeriod": true }, "expiry": { "units": 0, "at": "2019-08-24T14:15:22Z" }, "perks": [ "string" ] }, "error": null}Revoke a widget key; its sessions stop working at once (scope: rewards:write) DELETE
Previous Page
Apply a previewed SAF-T import: contacts, products, account links, opening stock and opening balances (one posted, immutable OP entry). 409 when already applied or opening balances are already posted. (scope: saft_import:write) POST
Next Page