Adjusting points
The Rewards module in Engage allows you to award customers with points based on achievements. While this can be done through an automation or a manual action in the Engage UI, there is also an endpoint specifically for this.
POST /api/v2/contacts/{contactId}/rewardpointtransaction
Here is an example payload:
{
"points": 123.45,
"description": "Points adjustment via Engage API"
}Caution
The points value you send here is an adjustment to the contact's points total.
Field definitions
Field name | Data type | Example value |
|---|---|---|
points | decimal | 25.95 (Value can either be positive or negative) |
description | string | Performed a review |
Response codes
If the request has been successful, you'll get a HTTP 200 OK response. Otherwise you'll get one of these:
404: ContactNotFound, BonusCheckNotFound
409: BonusCheckAlreadyRedeemed, BonusCheckExpired