Adjust Points

Adjust loyalty points for a specified program member or journal transaction.

This action is available in API version 51.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/adjustPointsAction

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
`AdjustmentCategory`	String	The category of adjustment.
`AdjustmentType`	string	Required. The type of adjustment required.
`JournalId`	ID	ID of the transaction journal.
`LoyaltyProgramCurrencyId`	ID	ID of the loyalty program currency.
`LoyaltyProgramMemberId`	ID	Required. ID of the loyalty program member to whom the points must be adjusted.
`Points`	Float	Required. The points available for the loyalty program member.
`PointsExpirationDate`	string	The date on which fixed-model non-qualifying points credited by the action expire. Points expiration date is only applicable when the adjustment is crediting points to the member. This input is available in API version 55.0 and later.
`ReasonforChange`	string	Required. The reason for adjustment.

Outputs

Output	Type	Description
`AdjustmentTransactionJournalId`	string	The ID of the adjustment transaction journal generated after the request is successful.

Example

Sample Request

1{
2   "inputs":[{
3      "LoyaltyProgramMemberId": "0lmxx00004000001AAB",
4      "LoyaltyProgramCurrencyId": "0lpxx00004000001AAB",
5      "Points": 500.0,
6      "PointsExpirationDate": "2022-08-12",
7      "AdjustmentType": "Credit",
8      "ReasonForChange": "Compensation"
9   }]
10}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{
5        "AdjustmentTransactionJournalId":"0lvxx00004000001AAB"}
6   }
7}