Loyalty Program Process

Run a loyalty process created from a loyalty program process template.

Out-of-the-box loyalty program process templates come with a default set of process parameters. You can configure new parameters or remove the default ones by simply cloning a template and running the configured parameters as a customized loyalty process using the loyalty program process API. For example, when using the CreditPointsToMembers process template to credit points to a loyalty member, you can configure the currency value so that the credited points can be redeemed in the currency you’ve specified.

The request and response parameters for the loyalty program process API vary depending on the input and output parameters configured for a loyalty program process in a Salesforce org.

Loyalty Process API	Loyalty Process Template Name	Description
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/CANCEL_VOUCHER`	`CancelVoucher`	Cancel a voucher.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/CREDIT_POINTS_TO_MEMBERS`	`CreditPointsToMembers`	Credit pre-calculated points to a loyalty member on every transaction.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/DEBIT_POINTS_FROM_MEMBERS`	`DebitPointsFromMembers`	Redeem a loyalty member’s pre-calculated points on a transaction.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/ENROLL_IN_PROMOTION`	`EnrollInPromotion`	Enroll a loyalty member to a promotion.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/GET_MEMBER_PROMOTIONS`	`GetMemberPromotions`	View eligible promotions of a loyalty member.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/ISSUE_VOUCHER`	`IssueVoucher`	Issue a new voucher to a loyalty member.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/UNENROLL_MEMBER`	`UnenrollMember`	Unenroll a member from a loyalty program.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/UPDATE_MEMBER_DETAILS`	`UpdateMemberDetails`	Update a loyalty member profile.
`/connect/loyalty/programs/DEMO_PROGRAM/program-processes/UPDATE_TIER`	`TierProcessing`	Change the tier for a loyalty member.

56.0

POST

Name	Type	Description	Required or Optional	Available Version
`programName`	String	Name of the loyalty program.	Required	56.0
`processName`	String	Name of the process created from a loyalty program process template.	Required	56.0

Properties

Name	Type	Description	Required or Optional	Available Version
`processParameters`	Loyalty Process Parameter Map	Input parameters for running the loyalty process.	Required	56.0

Loyalty Process Output

Cancel a Voucher

Change the status of a voucher to canceled.
Credit Points to Members

Credit pre-calculated points to a loyalty member on every transaction.
Debit Points from Members

Redeem a loyalty member’s pre-calculated points on a transaction.
Enroll for Promotions

Enroll a loyalty member to a promotion.
Get Member Promotions

View all eligible promotions of a loyalty member.
Issue a Voucher

Issue a new voucher to a loyalty member.
Unenroll a Member

Unenroll a member from a loyalty program.
Opt Out from a Promotion

Opt out a loyalty program member from an available promotion.
Update Member Details

Update personal and preference details of a member.
Update Member Tier

Upgrade or downgrade tier for a loyalty member.