Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Update Member Progress for Cumulative Promotion

Update the progress made by a loyalty program member towards attaining a Cumulative type promotion. The action creates a Loyalty Program Member Promotion record if the promotion isn't associated with the member.

For more information about this action, see Update the Member's Progress Towards Attaining a Cumulative Promotion in Salesforce Help.

This action is available in API version 53.0 and later for users in orgs where either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, or Loyalty Management - Advanced license is enabled.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/updateProgressForCumulativePromotionUsage
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
loyaltyProgramMemberId
Type
ID
Description
Required. ID of the loyalty program member who progress towards attaining a cumulative promotion must be updated.
promotionId
Type
ID
Description
Required. ID of the Cumulative type promotion for which member's progress must be updated.
usageIncrementForCumulativePromotion
Type
integer
Description
Required. The value or quantity that must be added to member's usage towards attaining the promotion.

For example, if the target of a promotion is 10 units and the member has previously purchased 1 unit. Now the member has purchased 4 units. In this scenario, the input must be 4 and not 5 (1+4).

Outputs

Output Details
cumulativeUsageTarget
Type
integer
Description
The target value or quantity which members must achieve to attain the promotion.
updatedCumulativeUsageCompleted
Type
integer
Description
The updated value or quantity by which the member has progressed towards attaining the promotion.

For example, if the target of a promotion is 10 units and the member has previously purchased 1 unit. Now the member has purchased 4 units. In this scenario, the output is 5.

Example

Sample Request

1{
2"inputs" : [
3     {
4"loyaltyProgramMemberId" : "0lMRxx0000006MfMAI",
5"promotionId": "0c8xx00000002MqIAI",
6"usageIncrementForCumulativePromotion": 4
7   }
8]
9}

Sample Response

1[ {
2  "actionName" : "updateProgressForCumulativePromotionUsage",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "cumulativeUsageTarget" : 10,
7    "updatedCumulativeUsageCompleted" : 5
8  }
9} ]