Loyalty Program Process

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.

Resource

/connect/loyalty/programs/${programName}/program-processes/${processName}

Resource examples

Loyalty Process API	Loyalty Process Template Name	Description
/connect/loyalty/programs/​​​DemoProgram/program-processes/​CancelVoucher	CancelVoucher	Cancel a voucher.
/connect/loyalty/programs/​DemoProgram/program-processes/​CreditPointsToMembers	CreditPointsToMembers	Credit pre-calculated points to a loyalty member on every transaction.
/connect/loyalty/programs/​DemoProgram/program-processes/​DebitPointsFromMembers	DebitPointsFromMembers	Redeem a loyalty member’s pre-calculated points on a transaction.
/connect/loyalty/programs/​DemoProgram/program-processes/​EnrollInPromotion	EnrollInPromotion	Enroll a loyalty member to a promotion.
/connect/loyalty/programs/​DemoProgram/program-processes/​GetMemberPromotions	GetMemberPromotions	View eligible promotions of a loyalty member.
/connect/loyalty/programs/​DemoProgram/program-processes/​IssueVoucher	IssueVoucher	Issue a new voucher to a loyalty member.
/connect/loyalty/programs/​DemoProgram/program-processes/​UnenrollMember	UnenrollMember	Unenroll a member from a loyalty program.
/connect/loyalty/programs/​DemoProgram/program-processes/​UpdateMemberDetails	UpdateMemberDetails	Update a loyalty member profile.
/connect/loyalty/programs/​DemoProgram/program-processes/​UpdateTier	TierProcessing	Change the tier for a loyalty member.

Available version

56.0

Requires Chatter

No

HTTP methods

POST

Request parameters

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

Request body for POST

Properties

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

Response body for POST

Loyalty Process Output