Reinstate Points Action | Loyalty Management Developer Guide

This action is available in API version 67.0 and later.

Supported REST HTTP Methods

URI: /services/data/v67.0/actions/standard/reinstatePoints
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearertoken

Inputs

Input	Details
loyaltyProgramCurrencyName	Type string Description Required. The name of the loyalty program currency that's used for the points to reinstate.
loyaltyProgramMemberId	Type id Description Optional. The ID of the member whose points to reinstate. Specify a value for this parameter or Loyalty Program Membership Number.
loyaltyProgramMembershipNumber	Type string Description Optional. The membership number of the member whose points must be reinstated. Specify a value for this parameter or Loyalty Program Member ID.
loyaltyProgramName	Type string Description Required. The name of the loyalty program associated with the member whose points must be reinstated.

Outputs

Output	Details
pointsReinstated	Type double Description The number of points reinstated to the member's loyalty account balance.
reinstatementTransactionJournalId	Type id Description The ID of the transaction journal that tracks the reinstated points.

Example

POST

Here's a sample request for the Reinstate Points action.

1{
2  "inputs": [
3    {
4      "loyaltyProgramName": "American Airlines",
5      "loyaltyProgramMemberId": "0lMSG0000001mnU2AQ",
6      "loyaltyProgramCurrencyName": "AAdvantage Miles"
7    }
8  ]
9}

Here's a sample response for the Reinstate Points action.

1[
2{
3    "actionName": "reinstatePoints",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9        "reinstatementTransactionJournalId": "0lVSG0000007n5d",
10        "pointsReinstated": 200
11    },
12    "sortOrder": -1,
13    "version": 1
14}
15]