Learn about the Unenroll Member process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
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 parameters. The Unenroll Member rule has one rule step to update the status of loyalty member in the Loyalty Program Member record. The parameters stores MemberID value that the rule uses to update the status of the member.
| Rule Step Name | What Does the Rule Step Do? | Parameters used in the Step | What Does the Parameter Do? |
|---|---|---|---|
| Change Member status | Updates the Loyalty Program Member record for the Inactive status based on the input parameter. | MemberStatus | The input parameter stores the member’s status as Inactive. |
How Can You Execute the Processes Created Using the Unenroll Member 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 Unenroll Member API by executing it when members leave the loyalty program.
- The API is invoked from an external system when members leave the loyalty program.
- The members’ status change is provided in the API request.
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 value for the parameter that’s used in the Change Member
Status rule.
You must specify the ID or Number of the Loyalty Program Member record that must be updated for the member’s status, the ID allows the process to identify which member’s status must be changed to Inactive.
When you execute the API, it runs the loyalty program process and the process updates the Loyalty Program Member record using the value provided in the API request. If the process contains the Change Member Status rule step, the process selected in the step is automatically run to change the status of the member to Inactive.
Examples of How You Can Use the Template
You can clone and extend the template based on your requirements. Here’s a way you can use the template:
| Use Case | How to Achieve the Use Case? |
|---|---|
| A loyalty program may have various channels to unenroll from the loyalty program. It can be on the website, app, or an option on the point of sale terminal. You may want to know channel-wise unenrollment of members. |
To track the unenrollment of members by channel, you can create a separate clone of the API for each channel. For example:
You can connect these separate APIs with the channel's Unenroll button. |