Newer Version Available

This content describes an older version of this product. View Latest

Credit Points Actions

Credit loyalty points to a specified loyalty program member’s balance.

This object 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/creditPoints
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
LoyaltyProgramMemberId
Type
ID
Description
ID of the loyalty program member.
ProgramCurrencyName
Type
string
Description
The name of the program currency.
ProgramName
Type
string
Description
The name of the loyalty program.
Points
Type
Float
Description
The points available for the loyalty program member.
CorrelationId
Type
ID
Description
ID of any Salesforce entity.
JournalId
Type
ID
Description
ID of the transaction journal.
AdditionalNotes
Type
String
Description
Additional information about the transactions performed by the loyalty program members.
FlowId
Type
ID
Description
ID of the flow associated with credit points action.

Outputs

Output Details
LoyaltyProgramMemberId
Type
string
Description
ID of the loyalty program member.
ProgramCurrencyName
Type
string
Description
The name of the program currency.
ProgramName
Type
string
Description
The name of the loyalty program.
JournalId
Type
ID
Description
ID of the transaction journal.

Example

Sample Request

1{
2   "inputs":[ 
3      {
4        "LoyaltyProgramMemberId":"0lMxx0000A000001EAA",
5        "ProgramCurrencyName":"Avios",
6        "ProgramName":"baLoyaltyProgram"
7        "Points":50.0,
8        "CorrelationId":"0lcxx00004000002AAA",
9        "JournalId":"0lcxx00204000001AAA",
10        "FlowId":"0lcxx00204000001AAA",
11        "AdditionalNotes":"Any additional Information"
12      }
13   ]
14}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5        "LoyaltyProgramMemberId":"0lMxx0000A000001EAA",
6        "ProgramCurrencyName":"Avios",
7        "ProgramName":"baLoyalty",
8        "JournalId":"0lMxx0000A000001EAA"
9   }
10}