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

NameTypeRequiredDescription
organization_idintegerYesYour organization ID. Must be the program's organization.
program_idintegerYesID of the loyalty program.
namestringYesTier name (1 to 120 characters).
thresholdnumberNoValue of the program tier_basis needed to reach the tier. Default 0.
earn_multipliernumberNo0 to 100. Default 1.
benefitsstring | nullNoText describing the benefits.
colorstring | nullNoColor, for example #F59E0B.
sort_orderintegerNoDisplay 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

StatusMessage / cause
400 Bad RequestProgram not found in this organization
400 Bad RequestSchema 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.