Create a loyalty tier
Add a tier to a loyalty program. Tiers only affect members when the program has tiers_enabled: true (points, stamps and cashback programs).
Endpoint
POST/loyalty-tiers
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Your organization ID. Must be the program's organization. |
program_id | integer | Yes | ID of the loyalty program. |
name | string | Yes | Tier name (1 to 120 characters). |
threshold | number | No | Value of the program tier_basis needed to reach the tier. Default 0. |
earn_multiplier | number | No | 0 to 100. Default 1. |
benefits | string | null | No | Text describing the benefits. |
color | string | null | No | Color, for example #F59E0B. |
sort_order | integer | No | Display order. Default 0. |
Request
Response
json
After the tier is created, every member of the program is re-evaluated in the background, so members who already reached the threshold move to the new tier.
Errors
| Status | Message / cause |
|---|---|
400 Bad Request | Program not found in this organization |
400 Bad Request | Schema validation failed (missing name, threshold below 0, earn_multiplier above 100, unknown field). |
Report an issue with this documentation
Please log in to report issues with our documentation.