Overview of Opt Out of Promotion Process Template

What Does the Template Contain?

The template contains a rule and a set of parameters. The Opt Out of Promotion rule has one condition and the condition has a child action.

Rule Step Name	What Does the Rule Step Do?	Parameters used in the Step	What Does the Parameter Do?	Examples of Customization
Is the Member Enrolled in the Promotion?	Checks whether the member is enrolled in the promotion that the member wants to opt out of.	LoyaltyProgramMbrPromotionRecord	Checks whether there’s a member promotion record that tracks the member’s promotion enrollment.	If you don’t want members to opt out of promotions after the enrollment period, add condition criteria that check whether the member is opting out of the promotion after the enrollment end date or the promotion end date.
Change Member's Promotion Enrollment to Not Active	Set the member’s promotion enrollment status as inactive.	LoyaltyProgramMbrPromotionRecord	Used to determine the member promotion record in which the member’s promotion enrollment status has to be set as inactive.	If you have a custom field to store the date that the member has opted out of the promotion on, add the field as an input parameter and use the TODAY () formula to store the date when the member has opted out of the promotion.
		LoyaltyProgramMbrPromotionId	Stores the ID of the member promotion record where the member’s promotion enrollment status is set as inactive.

The template has these parameters.

• MemberId—Stores the ID of the member who wants to opt out of the promotion.
• MembershipNumber—Stores the membership number of the member who wants to opt out of the promotion.
• PromotionId—Stores the ID of the promotion that the member wants to opt out of.
• PromotionName—Stores the name of the promotion that the member wants to opt out of.
• LoyaltyProgramMbrPromotionId—Stores the ID of the member promotion that tracks the member’s promotion enrollment status.
• LoyaltyProgramMbrPromotionRecord—Stores the details of the member promotion record that tracks the member’s promotion enrollment status.

How Can You Execute the Processes Created Using the Opt Out of Promotion Template?

The OptOutPromotion business API allows you to execute the processes created by cloning the Opt Out of Promotion loyalty program process template. You can integrate the API with the external system or website where you let members opt out of promotions.

To execute the API, you’ve to:

• Provide the API name of the cloned process in the API endpoint,
• Provide in the API request
  • The Loyalty Program Member ID or the membership number of the member who wants to opt out of the promotion.
  • The ID or the name of the promotion that the member wants to opt out of.

When you execute the API, the Opt Out of Promotion rule checks whether the member is enrolled in the promotion. If the member is enrolled, the rule changes the member’s promotion enrollment status to inactive. If the member isn’t enrolled in the promotion, a message informs the member that they aren’t enrolled in the promotion.

Examples of How You Can Use the Template

You can clone and extend the template based on your requirements. Here’s how you can use the process template:

Use Case	How to Achieve the Use Case Goal?
Members can opt out of promotions from the loyalty program’s site or from the company’s ecommerce site.	Integrate the OptOutPromotion business API with your loyalty program’s site and your company’s ecommerce site.
Ask customer service reps to contact the member to check why the member has opted out of the promotion.	Add a Create or Update Record action in the Opt Out of Promotion rule to create a task for customer service reps to contact the customer.