Change Customer's Loyalty Program

Enrolls the customer in a loyalty program, moves them to a different one, or removes them from loyalty entirely (loyalty_id: -1). When moving between programs, point_strategy decides what happens to the existing points balance: discard (the default) writes the points off, transfer converts them via money value into the new program. Removing a program also discards any remaining points. Requires the p/manage-loyalty permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Customer id.

Body Params
integer
required

Loyalty program id, or -1 to remove the customer from loyalty.

string | null
enum

Applied when switching programs. Defaults to discard.

Allowed:
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json