Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Adjust Points
Assign Member Tier Benefits
Accrual Cancellation
Credit Points
Change Tier
Change All Tiers or None
Debit Points
Generate Referral Code
Get Member's Active Segments
Get Points Balance
Get Promotions Based on Member's Market Segment
Get Promotions Based on Transaction Journal
Get Tier
Issue Voucher
Merge Memberships Action
Process Member Benefit
Redemption Cancellation
Run Program Process for Transaction Journal
Transfer Member Points to Groups
Unmerge Memberships Action
Update Member Progress for Cumulative Promotion
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

Credit Points

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

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

Inputs

Input Details
AdditionalNotes
Type
String
Description
Additional information about the transactions performed by the loyalty program members.
CorrelationId
Type
ID
Description
ID of any Salesforce entity.
FlowId
Type
ID
Description
ID of the flow associated with credit points action.
JournalId
Type
ID
Description
Required. ID of the transaction journal.
LoyaltyProgramMemberId
Type
ID
Description
Required. ID of the loyalty program member.
Points
Type
Float
Description
Required. The points available for the loyalty program member.
ProgramCurrencyName
Type
string
Description
Required. The name of the program currency.
PointsExpirationDate
Type
string
Description
The date on which fixed-model non-qualifying points credited by the action expire. This input is available in API version 55.0 and later.
ProgramName
Type
string
Description
Required. The name of the loyalty program.
LoyaltyProgramCurrencySubtypeName
Type
string
Description
Required. The name of the loyalty program currency subtype that is used to credit points from the member.

Outputs

Output Details
JournalId
Type
ID
Description
ID of the transaction journal.
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.

Example

Sample Request

{
   "inputs":[{
      "LoyaltyProgramMemberId": "0lMxx0000A000001EAA",
      "ProgramCurrencyName": "Avios",
      "ProgramName": "baLoyaltyProgram",
      "Points": 500.0,
      "PointsExpirationDate": "12-08-2022",
"CorrelationId": "0lcxx00004000002AAA",
      "JournalId": "0lcxx00204000001AAA",
      "FlowId": "0lcxx00204000001AAA",
      "AdditionalNotes":"Any additional Information"
   }]
}

Sample Response

{
   "errors":null,
   "isSuccess":true,
   "outputValues":{ 
        "LoyaltyProgramMemberId":"0lMxx0000A000001EAA",
        "ProgramCurrencyName":"Avios",
        "ProgramName":"baLoyalty",
        "JournalId":"0lMxx0000A000001EAA"
   }
}