Introduction
The General Settings page enables you to set Site-Level limits on the use of Custom IDs for all Actions in the system. A Custom ID is a value that can be assigned to an Action to facilitate business logic for Actions.
For example, within the system, you can set a limit on the use of Actions based on the number of times a specific Custom ID has been applied to an Action. If the limit is set to three, the Custom ID/Action combination can be used up to three times, and on the fourth attempt, an error is returned and the system does not award points for the Action.
Setting limits on the use of Custom IDs with Actions is not required. As long as the system is set to support Custom IDs, they appear in the All Interaction report and the Activity and Points APIs.
Also, the custom_id value is included in the All Interactions report and used in the Activity and Points APIs.
In the Super Admin tool, the Enable CustomID to Interaction Report & Activity API field must be enabled (checked) for Custom IDs to appear in the system.
Configuration
Navigation: Products > Additional Loyalty Settings > General Settings
- Toggle Enable Site Level CustomId Limit to ON to enable Custom IDs for all Actions in the system globally.
- In the Site Level CustomId Limit field, enter a whole number value to indicate the number of times an Action with the same associated Custom ID is allowed to award points. If the value in this field is exceeded, the system returns an error and points are not awarded.
The Site Level CustomId Limit field is NOT required, even if Enable Site Level CustomId is ON. If the field is left blank, there is no restriction on the use of the Custom ID.
Use Cases
-
Limiting Point Awards for Actions
You can set a limit on the use of Actions based on the number of times a specific Custom ID has been applied to an Action. If the limit is set to three, the Custom ID/Action combination can be used up to three times, and on the fourth attempt, an error is returned and the system does not award/redeem points for the Action. -
Limiting Transactions by Custom ID
Separate from point awards, the number of times an Action can be used can be limited based on the Custom ID associated with the Action. The Custom ID can serve as a Transaction ID for the use of an Action. When the Custom ID limit is reached, the Action cannot be repeated for the same Custom ID. -
Credit and Debit Actions
The use of Custom IDs applies to all Actions globally, including Actions that add points to a member’s point balance (Credits) and Actions that remove points from a member’s balance. (Debits).