Debit Points
Debit loyalty points from a specified loyalty program member’s balance. You can debit loyalty points to redeem for a service or upgrade the member to a higher tier.
This action updates the point balance in the LoyaltyProgramMemberCurrency table in your Salesforce org.
This action is available in API version 51.0 and later for users with Loyalty Management license.
URI: /services/data/vXX.X/actions/standard/debitPoints
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
| Input | Type | Description |
|---|---|---|
AdditionalNotes | String | Additional information about the transactions performed by the loyalty program members. |
CorrelationId | ID | ID of any Salesforce entity. |
FlowId | ID | ID of the flow associated with the debit points action. |
JournalId | ID | Required. ID of the transaction journal. |
LoyaltyProgramMemberId | ID | Required. ID of the loyalty program member to whom the points must be deducted. |
Points | Float | Required. The points available for the loyalty program member. |
ProgramCurrencyName | string | Required. The name of the loyalty program currency. |
ProgramName | string | Required. The name of the loyalty program. |
LoyaltyProgramCurrencySubtypeName | string | Required when ProgramCurrencyName uses the Activity with Mixed Subcurrencies expiration mode. The name of the loyalty program currency subtype that is used to debit points from the member. |
| Output | Type | Description |
|---|---|---|
JournalId | ID | ID of the transaction journal. |
LoyaltyProgramMemberId | string | ID of the loyalty program member. |
PointsBalance | Integer | The total points available for the loyalty program member. |
ProgramCurrencyName | string | The name of the program currency. |
ProgramName | string | The name of the loyalty program. |
Sample Request
Sample Response