Update a loyalty program

Change a program's settings (partial update), for example to activate, pause or archive it, or to change its earning rules or card design.

Endpoint

PATCH
/loyalty-programs/:id

Body parameters

Any field of Create a loyalty program except type and organization_id, which cannot be changed. Only the fields you send change. card_design and earn_rules are merged with the current values, so you can send only the keys you change.

Request

Response

Returns the updated loyalty program (same shape as Get a loyalty program).

Side effects

  • Changing name, card_design, terms, locations, status, stamps_required or currency_code refreshes every installed Apple Wallet and Google Wallet card of the program in the background.
  • Changing tiers_enabled or tier_basis recalculates every member's tier in the background.
  • archived programs do not accept new members.

Errors

All are 400 Bad Request:

MessageCause
The program type cannot be changedtype differs from the current type.
The organization cannot be changedorganization_id differs from the current organization.
Program not foundUnknown or deleted program.

The validation errors of Create a loyalty program also apply, checked against the program after the change.

Report an issue with this documentation

Please log in to report issues with our documentation.