Update Loyalty Settings
PUT/api/loyalty/settings
Update the tenant's loyalty program configuration. All fields are required and fully replace the stored settings.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token (PAT).
Permission: pos.manage.
Request body fields (all required):
enabled(boolean, required) — whether the program is active.points_per_dollar(numeric, required, min 0) — points earned per $1 of sale total before tax.redemption_value_per_point(numeric, required, min 0) — dollar value of one point when redeemed.min_redemption_points(integer, required, min 0) — minimum points required before redemption.
Returns 200 with { data: { ...settings }, message: "Loyalty settings updated." }.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.