Adjust Customer Loyalty Points

Manually adjusts a customer's loyalty points balance. type is add (add points to the balance), remove (subtract them) or set (make the balance exactly points). The customer must be enrolled in a point loyalty program, otherwise the call fails with 400 BAD_REQUEST. 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
string
enum
required
Allowed:
number
required
string
required
length ≤ 512

Reason recorded on the loyalty change entry.

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