You are here:
Overview of the Enroll in Promotion Process Template
Learn about the Enroll in Promotion process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Required Editions
| Available in: Lightning Experience in Enterprise, Performance, Unlimited, and Developer Editions |
| Available in: Orgs that have the B2C - Loyalty, B2C - Loyalty Plus, B2B - Loyalty, Loyalty Management - Growth, or Loyalty Management - Advanced license enabled |
What Does the Template Contain?
The template contains a rule and set of parameters. The Enroll in Promotion rule has only one rule step to enroll loyalty program members in the promotion based on the input parameters. The parameters stores parameter values that the rule uses to enroll in promotion.
| Rule Step Name | What Does the Rule Step Do? | Parameters used in the Step | What Does the Parameter Do? |
|---|---|---|---|
| Enroll in Promotion | Enrolls loyalty program members in a promotion based on the input parameters. | MemberId or MembershipNumber | The input parameter stores the identifier of the loyalty program member. |
| PromotionId or PromotionName | The input parameter stores the identifier of the loyalty promotion into which the member is enrolled. | ||
| IsEnrollmentActive | The input parameter stores the enrollment status of the loyalty program member in the promotion is active or inactive. | ||
| RecordId | Stores the identifier of the Member record. |
How Can You Execute the Processes Created Using the Enroll in Promotion Process Template?
Loyalty Management provides a Business API to execute processes created by cloning loyalty program process templates. You can integrate the external system and Loyalty Management with the Enroll in Promotion API by executing it as per the input parameters.
In the API, you must specify these values to execute the API for your cloned process:
- In the API endpoint, specify the API name of your cloned process.
- In the API request, specify the values for the parameters that are used in the Enroll in
Promotion rule.
You must specify the MemberId or MembershipNumber and PromotionId or PromotionName in the request.
When you execute the API, it runs the loyalty program process and the process enrolls loyalty members in promotions using the value provided in the API request.
Examples of How You Can Use the Template
You can clone and extend the template based on your requirements. Here’s a way to use the template:
| Use Case | How to Achieve the Use Case? |
|---|---|
| Enroll loyalty members in multiple promotions and track channel-wise enrollments. | Specify MemberId or MembershipNumber and PromotionId or PromotionName in the API request. If you have different channels to enroll (web, POS, mobile app) and track enrollments by channel, then create multiple clones of the Enroll in Promotion process template and track the data flow through each of the channels separately. |
