Create a loyalty program

Create a stamp card, points program, cashback program, membership or gift card. New programs start as draft: activate them with "status": "active" (here or later with an update).

Endpoint

POST
/loyalty-programs

Body parameters

NameTypeRequiredDescription
organization_idintegerYesYour organization ID (the API key's organization).
namestringYesProgram name (1 to 255 characters).
typestringYesstamps, points, cashback, membership or gift_card. Cannot be changed later.
statusstringNodraft (default), active, paused or archived.
slugstringNoLink name for the public enrollment page. Generated from name when omitted.
currency_codestringNoCurrency, for example USD. Required before a cashback or gift_card program can be active.
description, earn_rules, stamps_required, cashback_percent, welcome_bonus, birthday_bonus, referrals_enabled, referrer_bonus, referred_bonus, expiration_days, min_redeem_amount, membership_uses, membership_validity_days, gift_card_default_amount, tiers_enabled, tier_basis, card_design, locations, enrollment_settings, terms, public_enrollment_enabled, apple_wallet_enabled, google_wallet_enabledNoSee Fields.

Request

Response

Returns the created loyalty program with enrollment_url and wallet_availability.

json

Defaults by type

TypeDefault when omitted
stampsstamps_required: 10
pointstier_basis: "lifetime_points"
cashbackcashback_percent: 5
membershipmembership_uses: 10

card_design and earn_rules get the default design and rules shown above. Keys you send are merged over them.

Errors

All are 400 Bad Request:

MessageCause
This link name is already used by another programThe slug you sent is taken in your organization. Without slug, a free one is generated.
A stamp card needs between 2 and 30 stampsstamps_required out of range.
Cashback must be between 0 and 100 percentcashback_percent out of range.
Cashback and gift cards need a currencyactive cashback or gift card without currency_code.
A membership needs at least one usemembership_uses below 1.
Expiration must be at least one dayexpiration_days below 1.
Tiers are available for points, stamps and cashback programstiers_enabled on a membership or gift card.
Referrals are available for points, stamps and cashback programsreferrals_enabled on a membership or gift card.
card_design.<key> must be a #RRGGBB colorInvalid color.
earn_rules.<key> must be a positive number / earn_rules.amount_step must be greater than zeroInvalid earning rule.
A card supports up to 10 locations / Invalid location latitude / Invalid location longitudeInvalid locations.

Report an issue with this documentation

Please log in to report issues with our documentation.