Custom Parameters

What Are Custom Parameters?

Definition: Custom Parameters allow you to dynamically modify coupon attributes when assigning them to customers. This means that a coupon’s value or text can change based on the assigned parameter.

Purpose: By leveraging Custom Parameters, you can create more personalized coupon experiences for your customers, making your promotions more flexible and efficient.

By utilizing the API, you can dynamically assign coupons with varying values. For details on assigning a coupon to a member, refer to the API documentation: Assign a Coupon to a Member

Configuring Custom Parameters

Before using Custom Parameters in coupons, you need to create them in the system.

1. Creating a Custom Parameter

To set up a Custom Parameter, navigate to: Settings > Custom Parameters
Follow the guide on Custom Parameters to create a new parameter.

2. Custom Parameter Settings

When creating a Custom Parameter for use with coupons, ensure that:

• Entity = User Coupons
• Context = _Coupon

Additional settings should be configured as shown in the following screenshot:

Using Custom Parameters in Coupons

Once a Custom Parameter is created, it can be referenced inside a coupon’s description using the following syntax: {{coupon.user_coupons.0.param.slug}} where "slug" corresponds to the slug name of the created Custom Parameter.

When assigning the coupon via API, the Custom Parameter should be provided inside the "params" object. The assigned value will then be displayed inside the coupon text dynamically.

Example Use Case

Scenario:
A company wants to distribute a coupon to customers with a dynamically assigned discount value.

Steps:

1. Create a Generic Coupon

   • The coupon description should include the placeholder:

     {{coupon.user_coupons.0.param.slug}}
     

2. Create a Custom Parameter

   • Configure the parameter under Settings > Custom Parameters
   • Ensure the correct Entity and Context are set.

3. Assign the Coupon Using API

   • Use the Assign a Coupon to a Member API.
   • Fill the "params" object with the desired value:
     JSON

     {
       "params": {
         "slug": "500"
       }
     }
     

   • The coupon will be added to the customer with the correct dynamic value.

The following screenshot demonstrates the result in app as we´ve been changing the params value:

Preactivation

Pre-activation of Coupons

By default, customers need to manually activate a coupon before they can redeem it. However, in some cases, businesses may want to skip this step and provide customers with coupons that are already activated upon assignment.

This is where the Activate on Assignment feature comes into play. You can choose one of two options:

1. All coupons are already preactivated.
2. Combination of coupons which need to be activated manualy with preactivated coupons.

1. All coupons are already preactivated

   • In the Settings > General Settings you can find function Preactivate Assigned Coupons.
   • Turn this function ON so all coupons will be automatically assigned as already activated.

   

2. Combination of both (not-activated & pre-activated coupons)

   • Firstly, make sure that function Preactivate Assigned Coupons in General Settings is turned OFF.
   • Navigate to the coupon settings while creating or editing a coupon.
   • Enable Activate on Assignment so the coupon is automatically activated the moment it is assigned to a customer.
   • From the customer’s perspective, the coupon appears in the app as already activated, eliminating the need for manual activation.
   • This feature enhances user experience by removing unnecessary steps and making the redemption process more efficient but also keeps you an option to assign a coupons that need to be activated manually.