Adjust Loyalty Points
POST/api/customers/:customer/loyalty/adjust
Manually add or remove loyalty points for a customer. Writes a signed adjustment ledger entry — a positive points value adds, a negative value removes.
customers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (PAT).
Permission: customers.update.
Request body fields:
points(integer, required,not_in:0) — signed points to apply. Positive adds, negative removes. Error message when 0: "The points adjustment must be non-zero."notes(string, nullable, max 2000) — internal note for the adjustment.
A negative adjustment that would drive the balance below zero is rejected with 422 (InsufficientLoyaltyPointsException).
Returns 201 with { data: <ledger entry>, points_balance: <int>, message: "Loyalty points adjusted." }.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.