Adjust points
Customers
Adjust points
Manually add or deduct points for a customer.
POST
Adjust points
Manually add or deduct points for a customer. Useful for CS teams handling complaints, migrations from another platform, or any bespoke earning scenario not covered by earning rules.Documentation Index
Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt
Use this file to discover all available pages before exploring further.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
adjustment | integer | Yes | Points to add (positive) or deduct (negative). Cannot be zero. |
note | string | No | Internal note stored on the audit record |
update_lifetime_points | boolean | No | Whether to also adjust lifetime points. Default: true |
send_email | boolean | No | Whether to send a points-earned email to the customer (increases only). Default: true |
Behaviour
- Points balance floors at
0— deductions will never produce a negative balance - Customer tier is recalculated automatically after the adjustment
- Creates an audit trail entry in the customer’s earning history
Side effects
All non-blocking:- Recalculates and updates VIP tier
- Sends points-earned email on increases (if
send_email: true) - Syncs customer to Klaviyo, Omnisend, and Postscript
Response
Returns200 OK:
Errors
| Status | Scenario |
|---|---|
400 | adjustment missing, zero, or not an integer |
403 | Customer is excluded from the loyalty program |
404 | Customer not found |