Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Associated Objects
Apex Language Reference
Loyalty Management APIs
Loyalty Management Standard Invocable Actions
Adjust Points Actions
Assign Member Tier Benefits Action
Accrual Cancellation Actions
Credit Points Actions
Change Tier Actions
Change Tier With No Partial Success Actions
Debit Points Actions
Get Points Balance Actions
Get Tier Actions
Issue Voucher Action
Process Member Benefit Actions
Redemption Cancellation Actions
Data Processing Engine, Batch Management, and Monitor Workflow Services
Decision Table
PDF

Newer Version Available

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

Change Tier With No Partial Success Actions

Change tier for a specified loyalty program member only when all the input parameters meet the criteria.

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

Inputs

Input Details
TierGroupName
Type
string
Description
The name of the tier group.
ProgramName
Type
string
Description
The name of the loyalty program.
TargetTierName
Type
string
Description
The new tier to be associated with the loyalty program member.
LoyaltyProgramMemberId
Type
ID
Description
ID of the loyalty program member.
ChangeReason
Type
string
Description
The reason for change in the tier.

Outputs

Output Details
TierGroupName
Type
string
Description
The name of the tier group.
ProgramName
Type
string
Description
The name of the loyalty program.
TargetTierName
Type
string
Description
The new tier associated with the loyalty program.
LoyaltyProgramMemberId
Type
ID
Description
ID of the loyalty program member.
ChangeReason
Type
string
Description
The reason for the change in the tier of the loyalty program member.
ChangeReasonType
Type
string
Description
The reason type for change in the tier.

Example

Sample Request

1{ 
2   "inputs":[ 
3      { 
4         "TierGroupName":"Default Tier Group",
5         "ProgramName":"Rewards program",
6         "TargetTierName":"Gold",
7         "LoyaltyProgramMemberId": "0lcxx00006000001AAA",
8         "ChangeReason":"Reason to change the tier"
9      }
10   ]
11}

Sample Response

1{ 
2   "actionName":"changeTierWhenNoErrors",
3   "errors":null,
4   "isSuccess":true,
5   "outputValues":{ 
6      "LoyaltyProgramMemberId":"0lcxx00006000001AAA",
7      "TierGroupName":"Default Tier Group",
8      "ProgramName": "Rewards program",
9      "TargetTierName":"Gold",
10   }
11}