BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.
Points
Adjust customers points balance
Add or remove points from a customers points balance.
put /organizations/{organizationId}/customers/{customerId}/points/{reference}Parameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
customerId | string | path | Unique ID of the Customer |
reference | string | path | Unique identifier from service requesting point adjustment |
Request Body
PointsAdjustmentPayload
{
"amount": 5,
"notes": "Manual adjustment using api"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: duplicate_point_record: Conflict response.
Reverse points
Revert previous addition or removal of points using reference.
delete /organizations/{organizationId}/customers/{customerId}/points/{reference}Parameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
customerId | string | path | Unique ID of the Customer |
reference | string | path | Unique identifier from service requesting point adjustment |
Request Body
PointsReversalPayload
{
"notes": "Manual adjustment reversal using api"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: duplicate_point_record: Conflict response.
Models
PointsAdjustmentPayload
Adjust point payload
| Name | Type | Description |
|---|---|---|
| amount | integer | Points to be added or removed from customer's point balance.
Amount must be negative to remove points and positive to add points. e.g. 5, -14 |
| notes | string | (optional) Note for points change history. |
PointsReversalPayload
Reverse point payload
| Name | Type | Description |
|---|---|---|
| notes | string | (optional) Note for points change history. |