POST /v2/loyalty/accounts/{account_id}/adjust
Adds points to or subtracts points from a buyer's account.
Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call AccumulateLoyaltyPoints to add points when a buyer pays for the purchase.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
The ID of the loyalty account in which to adjust the points. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
adjust_points |
Object | Yes |
Provides metadata when the event |
adjust_points.points |
Integer | Yes |
The number of points added or removed. |
adjust_points.loyalty_program_id |
String | No |
The Square-assigned ID of the loyalty program. |
adjust_points.reason |
String | No |
The reason for the adjustment of points. |
idempotency_key |
String | Yes |
A unique string that identifies this |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.