Summary
- Campaign functionality allows marketers to offer rewards or incentives to members based on their behavior during a specified time period. Campaigns can leverage a segment of members or a list of milestones to unlock special rewards to loyalty members.
- Refer to Multi-Template documentation for further information about configuring campaigns with multiple templates.
Navigation: Products > Campaigns

Capabilities
The Campaigns feature allows marketers to create, edit, and manage loyalty campaigns within the Annex Cloud platform. The campaigns page presents a list of available campaigns and high-level details. The screenshot below points out additional controls for managing campaign entries.
The campaign feature enables an administrator to create, maintain, and view a campaign for the loyalty program.

- Add New Campaign: Start the process of creating a campaign.
- Search: Search all previously configured campaigns in the system.
- Export: Export a list of campaigns in either CSV or Excel format.
- Status: Toggle the campaign status to ON or OFF to make it active or inactive within the program.
-
Actions: There are three options in this column. The third option appears only when the individual validity toggle is ON.
- Edit an existing campaign.
- View audit logs related to the edit history of the specific campaign.
- Export the individual validity per member. If the individual validity toggle is ON and the system has started receiving the individual validity of the target members, then the user can export the individual validity dates for each member.
Configurations
Adding a New Campaign
On the campaign screen, click Add New Campaign. The campaign configuration screen appears. There are three steps to create a new campaign:
- General Information
- Audience and Milestones
-
Campaign Benefit
General Information
Provide a name for the campaign and set the date-time range for which the campaign will be active. The campaign start date can be the current date or a future date. This allows campaigns to be planned and set up in advance.
A campaign with a start date later than the current date automatically triggers at the specified start date and time.
Note: The end date of a campaign can be extended before the campaign expires.
Fields and Description
| Fields | Description | ||
| Campaign Name | Enter the Name of the campaign. | ||
| Date Range |
|
||
| Time From |
Provide the Start Time for the campaign. If the time zone is set: |
||
| Time To | Provide the End Time for the Campaign. | ||
| Apply Individual Validity |
Toggle the apply individual validity ON (Enabled) or OFF (Disabled). More details are shown later in the document. |
||
| Activation Required |
Toggle the activation required ON (Enabled) or OFF (Disabled). More details are shown later in the document. |
||
| Campaign Status |
Toggle the campaign ON (Enabled) or OFF (Disabled). Campaign works only if the campaign status is enabled(active). |
||
| Campaign UI Settings (Click the heading to display these controls. All the settings below are applicable for API based clients. We do not show these on the Annex Cloud iFrame). | |||
| Image URL | Enter a URL for the Image associated with the campaign. The image is visible to loyalty members on the dashboard. | ||
| Description | Enter a Description of the campaign. The description is visible to loyalty members on the dashboard. | ||
| Tagline | Enter a Tagline (marketing slogan) for the Campaign. The tagline is visible to the loyalty members on the dashboard. | ||
| Terms & Conditions | Enter rules and compliance information to help the member understand how the campaign works. | ||
| Group Name | Enter a name for the Group of campaigns to which this campaign belongs, if any. | ||
|
Campaign Extended Attributes: These are custom fields used to store additional data relevant to the campaign. These attributes allow for more flexible campaign management, segmentation, and reporting. Enter a value for the attribute configured. | |||
Apply Individual Validity

- The individual validity enhancement allows you to create a campaign where loyalty members have different validity dates for the same benefits. This feature lets you set a general validity period for the campaign and assign personalized validity periods for each member within this duration.
- Enable “Apply Individual Validity“ if you want to send individual validity for each target member via individual validity API during the campaign period. By default, this setting is disabled, meaning only the campaign validity is considered.

- For the campaigns where “Apply Individual Validity“ is enabled, you have to or you are required to send the individual validity start and end dates with reference to the target user IDs.
- A member is allowed to participate and earn the campaign benefits only during their respective individual validity period, which must always be within the Campaign period.
- If a segment is associated with the campaign, the segment condition is only considered during each member’s valid individual validity dates.
Note: This functionality requires updating your Campaign APIs to access the complete data.
Note: The time window defined in the segment matrix is not applicable in the case of individual validity.
Use Case 1: Member A makes two purchases from Store ID 101 or 102, and earns 2x points.
- This segment is associated with a campaign where “Apply individual validity” flag is enabled and the campaign is valid for the entire 2024.
- Member A has individual validity start date as March 1st, 2024, and end date as March 15th, 2024.
If Member A makes a purchase from the Store ID 101 on February 11th, 2024, this purchase will not be counted as it is outside his individual validity period. - However, if Member A makes a purchase from Store ID 101 on March 5th, 2024, then this purchase will be considered as the first qualifying purchase as it falls within the individual validity period.
- A second purchase from Store ID 102 on March 15th, 2024, will award the campaign benefit of 2x points.
Note: The member will not receive the campaign benefit if the campaign has expired.
- Reset/resend Individual Validity: A member can receive multiple individual validity periods, (new individual validity start and end dates) within a campaign, allowing them to participate and leverage the benefits of the same campaign multiple times.
- Individual Validity Extension: If the individual validity end date is extended while keeping the start date the same, the member can continue participating as the campaign, as it remains valid for them until the extended period of time.
Activation Required

- The activation required enhancement allows you to create campaigns where members must join to participate in and earn benefits. This enables you to analyze member interests, engage more personally, send reminders to those who haven’t enrolled, and run surveys to gather feedback and encourage participation.
- Enable this setting if you want loyalty members to activate the campaign via the Activation API to participate in the campaign. By default, it is disabled.
- If “Activation Required” is enabled, members can achieve the campaign benefits only after activating the campaign through the Activation API.
- If a segment is associated with such a campaign, the segment condition is only considered after the member activates the campaign.

- If a Campaign has both “Activation Required“ and “Apply Individual Validity“ toggles enabled, then the member should be able to avail the campaign benefits only if they are within the valid individual validity period, have activated the campaign during their individual validity period, and satisfy any segment conditions.
- For activation-required campaigns without individual validity, the campaign needs to be activated only once during the campaign validity period.
The campaign can be manually enabled or disabled. The campaign is considered active only when it is enabled. You can receive benefits for active campaigns after fulfilling the eligibility criteria and completing required actions during the campaign period.
Click Next. The Audience and Milestones screen appears.
Audience and Milestones

The audience and milestones section allows administrators to specify the target audience for the campaign milestone, determining which customers are eligible to benefit from it. You can add the target audience, the actions they must complete, and the benefits they will earn per milestone. Multiple milestones can be configured one at a time.
Example:
-
Campaign: Earn points based on the fuel type.
e 1: Fill regular fuel type and earn 2x points.ne 2: Fill premium fuel type and earn 3x points.
Note: If multiple milestones are created for the same action and a member qualifies for more than one milestone in a single activity, the latest created milestone will be applied.
Target Audience
Specify the target audience for the campaign. If you do not complete any of the target audience fields, the campaign includes all loyalty members on the site.

Fields and Description
| Fields | Description |
| Segment |
Select a Segment from the drop-down list to use as an audience for the campaign. At least one segment must exist in the platform to populate the drop-down list. All the configured segments are listed here. |
| Tier |
If a user selects one or more Tiers from the drop-down list, then the members who currently belong to any of the selected Tiers are eligible as an audience for the campaign. All the configured tiers are listed here. You can also select multiple tiers. |
Note: If you want to run a Campaign for all the loyalty members in the program, you do not need to select any Segment or Tier here.
Milestone
Add the action in the milestone that the target members must perform to earn the defined benefit upon completing the associated condition (if any).
Milestone Basic Details
| Fields | Description | |
| Milestone Name | Enter a Name for the milestone. | |
| Type |
Select the Type of milestone supported by the campaign. i) Action: Select a single action. For example: 109 - Purchase
Note: Both action ID and action name are displayed in the drop-down for selection.
ii) Action Series: A group of actions configured into an action series. For a list of Standard and Custom Actions, click here. The actions and action series must be configured prior to campaign configuration to be included as a campaign milestone. |
|
| Details | Based on the selected Type, choose the required Action or Action Series as a milestone to complete the campaign. | |
| Milestone Benefit Settings |
The first field in the Milestone Benefit Settings will be determined by the action selected in the Details field. If the Purchase action is selected the first field will be listed as Benefit for specific products. If a non-purchase action is selected, the first field will be listed as Bonus Type. See the related documentation below.
|
|
| Benefit for specific products |
No- Milestone benefit is applicable on the entire qualified Order. Yes- Milestone benefit is applicable on the Segment qualified products only. If you have a segment created to exclude a specific product or product category and this exclusion will apply to any associated campaign then regardless of whether the benefit for specific products is marked as No or Yes, the excluded product or product category will not receive any campaign benefits. However, all other products or product categories that are not excluded will continue to receive the campaign benefits.
|
|
| Bonus Type |
|
|
| Milestone Bonus |
Note: If the Bonus Type is selected as Ratio, the points awarded for the purchase are multiplied by the ratio value in the Bonus field. |
|
|
You can apply a multiplier on awarded points using the Transaction Type Ratio with the Campaign Milestone Ratio.
Navigation: Action Rules > Add New Action > Purchase Ratio
|
||
|
If the user would like points earned from the campaign to have an expiration date, expiration limits can be applied as:
|
|
| Milestone Limit Settings | ![]() |
|
| Maximum Achievement Limit |
Maximum Achievement Limit can be defined as the maximum number of times a member can earn the milestone benefit. By default, there is no limit. The limit can be defined Per Day, Week, Month, Year, Campaign or Individual Validity.
|
|
| Maximum Point Limit |
|
|
| Milestone Additional Settings | ![]() |
|
| Milestone Description | Enter any additional milestone details in the Milestone Description. | |
| Active Image URL | Enter the URL for an Image for the milestone when the campaign is Enabled. Applicable only for API based clients, not applicable for our iFrame. | |
| Inactive Image URL | Enter the URL for an Image for the milestone when the campaign is NOT Enabled. Applicable only for API based clients, not applicable for our iFrame. |
Click Create Milestone. The Campaign Milestone appears in the data grid. Repeat these steps to add more milestones as applicable.
Apply only one milestone during an Individual Validity:
If the “Apply Individual Validity” flag is enabled and multiple milestones are created in a campaign, the following toggle is shown to allow the admin to restrict the member to earn benefits from only one valid milestone per individual validity period. All other underlying rules of the milestone will apply as is. By default, the toggle is disabled.

Click Next, and the Campaign Benefits screen appears.
Campaign Benefits
The user can add the additional Campaign Bonus Points or Reward you can earn as a Campaign Benefit upon campaign completion.
Marketers can define any additional Benefit which can be awarded to you for completing the Campaign.

Fields and Description
| Fields | Description |
|---|---|
| Name | Enter the Benefit Name. |
| Image URL | Provide the URL for any images associated with the Campaign Benefit. |
| Benefit Type |
|
|
|
|
|
|
|
| Campaign Benefit Limit Settings | ![]() |
|
|
|
Note: By default, the Campaign Bonus Points are awarded once during a Campaign. |
| Benefit Type |
|
|
|
|
|
|
|
Click Create Campaign. A confirmation pop-up screen appears with the message, “Congratulations! The campaign was added successfully”.
Use Cases for Holding Campaign Bonus Points
Companies can face the issue of campaign products or services being returned after the points awarded as part of the campaign were utilized. Therefore, there is a way to get the campaign bonus points back if the order was Cancelled or Returned after the Campaign Bonus Points have been credited to the member’s account.
The Campaign Benefits feature allows clients to:
- Hold the awarding of Campaign Bonus Points and release them at a later date.
- Remove Campaign Bonus Points if the customer cancels or returns a Campaign item and is therefore no longer eligible for the Campaign.
Note: Campaign Bonus Points are awarded against a Standard Action known as Campaign Benefit and the Action Id is 1008.
This action does not need to be configured to work. Whether it has been configured or not, it triggers if there is a campaign based on Campaign Bonus Points. The entry of the same is reflected in the respective reports and the loyalty member’s Reward Dashboard.

Hold Points: This gives the admin the ability to decide at what stage to award Campaign Bonus Points to you once the campaign is complete.
Note: By default, the Campaign Bonus Points are awarded immediately as soon as the member completes the Campaign.
The administrator can select the number of days after which the Campaign Bonus points are credited to the member’s account once the Campaign is completed.
Use Case 1: The administrator wants to delay awarding Campaign Bonus Points until the campaign has been completed. The administrator enters the number of days to hold these points. In this case, “10” days have been defined as the Hold Points delay. Once the member has completed the campaign, the Campaign Bonus Points are kept on hold for 10 days. The Campaign Bonus Points are awarded to the member once 10 days have passed.

Use Case 2: For any Purchase based Campaign, the administrator wants Campaign Bonus Points to be awarded to the member only after the first consignment of the order has been shipped. The administrator selects the option of “After First Shipment” from the drop-down menu in the Hold Points section. In this case, “0” days has been defined as the Hold Points delay after the shipment of the first consignment. Once the member places an order, as soon as the first shipment takes place, the member is credited with the Campaign Bonus Points.

Use Case 3: For any Purchase based Campaign, the administrator wants to add additional criteria along with After First Shipment, so points are awarded to the member only after a specified number of days has passed since the first consignment of the order was shipped. The administrator selects After First Shipment from the drop-down menu and defines the number of days that the Campaign Bonus Points should be held in the Hold Points section. When the member places an order, the Campaign Bonus Points are kept on hold until the specified number of days has passed after the first shipment. In this case, the administrator has selected a delay of 10 days. 10 days after the first consignment has been shipped, the Campaign Bonus Points are awarded.

Note: If the Campaign is based on NON-PURCHASE ACTIONS or ACTION SERIES, Use Case 2 and Use Case 3 are not applicable.
New Additions in the Order Report:
- Points On Hold: Campaign Bonus Points if on hold are shown in the Points on Hold section based on the criteria set by the administrator.
- Points Earned and Points Awarded: Campaign Bonus Points if EARNED and AWARDED are shown in the Points Earned and Points Awarded sections respectively based on the criteria set by the administrator.
Note: Similarly in the Order API response, the Points Awarded, and Points on Hold parameters also reflect Campaign Bonus points along with the Purchase points.

Hold Points Report showing the Campaign Bonus Points (Action: Campaign Benefit) on Hold:

Returns and Cancellation Scenarios:
- For Partial Cancellation and Partial Returns:
If the order has been partially cancelled or returned, which makes the remaining order no longer eligible for the Campaign Bonus Points, the Campaign Bonus Points if credited are removed from the member’s account, and if on hold the Campaign Bonus Points are not released to the member’s account after the hold period.
- For Full Cancellation and Full Returns:
If the full order is Cancelled or Returned, Purchase Points and Campaign Bonus Points are removed from the member's account.
The Reason for the deduction of points can be seen in the All Interaction Reports.

Maximum Achievement Limits and Maximum Points Limits
- The client has an option to apply limits on the Points Earned and the number of times Campaign Achievement Awards can be earned for a campaign.
- Usage Capping: Set the number of times a member can receive a promotion offer.
- Points Capping: Set the number of points a member can reach in total either by transaction or during the promotional period.
Process to Apply Limits for Campaigns
The following flag must be enabled in the super admin for the points differentiation logic to work as expected.
Note: Enable campaign points differentiation in API and capping.
- When the flag is enabled under Campaign Milestones and Campaign Benefits, you have the options of Maximum Achievement Limit and Maximum Point Limit.
- If you apply a capping limit for a new campaign or existing campaigns, the capping is applied only on actions completed after the limit is set.
- To apply a capping limit for a new campaign, follow the process below:

Maximum Achievement Limit
- This is the number of times a member can get the bonus. Define it for a particular Day, Week (Mon-Sun), Month, Year, Campaign or Individual Validity.
- Details of Maximum Achievement Limit on a daily or weekly basis:

Maximum Point Limit
- This is the maximum number of points a member can get from a campaign for a particular time duration. You can define it for a particular Day, Week (Mon-Sun), Month, Year, Campaign or Individual Validity.
- Details of Maximum Point Limit on daily and weekly basis:

Edit Existing Campaign Information
- On the Campaigns data grid, click the Edit icon. The campaign configuration screen allows editing of existing campaign information.
- Administrators can jump to the required section and edit the information for that campaign section page by clicking Next.
- Click Update Campaign once the existing information is edited. The desired information updates successfully.

Export individual validities per member

- On the campaign's data grid, click the Export individual validities per member icon.
- The data can be exported by making an Excel request. The admin will receive the data via email. More email addresses can be added, and the link to download the data will be delivered to the entered email addresses.
- After entering valid email addresses, click Save.

- The data in the Excel file includes the user ID, individual validity start date, and individual validity end date.

- As soon as we receive another individual validity dates of a member, we will add Individual Validity Start Date and Individual Validity End Date as shown below:

Note: The "Export Individual Validity per Member" icon is visible only when the Apply Individual Validity toggle is enabled.
Searching Existing Campaign Information
Marketers can search previously configured campaigns in the system based on the available search criteria.
Click the down arrow icon in the search box. A pop-up appears to search for the available campaigns in the system based on the different search options.

Fields and Description
| Fields | Description |
| Campaign Name | Enter the Campaign Name to search for the desired campaign. |
| Campaign ID | Enter the Campaign ID to search for the desired campaign by its ID number. |
| Status |
Select the Status from the drop-down list. Valid values are: Off: All inactive Campaign records display. On: All active Campaign records display. |
| Created within |
Select Calendar Time Frames from a drop-down list within which the campaign was created. Valid values are: Day Week Month OR Administrators can select the specific date range within which the campaign was created. |
| Campaign Benefit |
Select the Campaign Benefit Type from the drop-down list. Valid values are: Campaign Bonus Points: Marketers can search for the campaign created based on Campaign Bonus Point as Benefit Type. Reward: Marketers can search for the campaign created based on Reward as Benefit Type. |
| Should have action rules as milestone | Select the Action Rule from the drop-down list. |
| Should have action series as milestone | Select the Action Series from the drop-down list. |
| Should have number of milestone | Enter the number of Milestones available in the Campaign. |
Settings
On the settings page, there is a feature called Multiple Campaign Benefit that allows you to receive benefits from multiple campaigns simultaneously. To award bonus points from multiple campaigns, turn ON the Multiple Campaign Benefit flag. When you turn ON the flag, a pop-up page will appear prompting you to click Proceed.

Once you turn ON the flag and complete the required actions, you will receive bonus points for the eligible campaigns.

For example, let's consider two campaigns: 500 Bonus on X product and Flat 100 points on spend as shown in the image below. The loyalty member is eligible for both campaigns. The 500 Bonus on X product campaign is based on product purchase. If the loyalty member buys this product, they will receive 500 bonus points. Similarly, the Flat 100 points on spend campaign is open to all loyalty members. If a loyalty member makes a purchase during this campaign period, they will be awarded 100 bonus points.

Once the loyalty member purchases the product, they will receive 500 points for the first campaign and 100 points for the second campaign, as shown in the image below.

Audit: To review the ON and OFF status of the flag, click Audit.

Multi-Campaign Award Logic
When a member qualifies for multiple campaigns, the system prioritizes awarding points from the higher-ratio or product-based campaign first. If the member reaches the maximum points limit for that campaign, the system automatically applies the next eligible campaign to ensure the member continues receiving rewards.
This logic ensures members are always awarded benefits from active campaigns, even after reaching the limit in a higher-priority campaign.
Configuration Example:
Campaign |
Ratio |
Max Limit |
Product-Based |
Description |
|---|---|---|---|---|
Camp_1 |
3X |
50,000 |
Yes |
High-value, product-based campaign with a defined limit |
Camp_2 |
2X |
No Limit |
No |
General campaign applicable to all purchases |
Example Behavior:
- The member is eligible for both Camp_1 (3X) and Camp_2 (2X).
- The system applies Camp_1 benefits until the maximum limit of 50,000 points is reached.
- Once the limit is reached, Camp_2 benefits (2X points) are automatically applied for eligible purchases.
- Exception: Products excluded from Camp_2 will not receive bonus points once the Camp_1 limit is reached.
Use Case 1: Normal Switching After Limit
If a member purchases an eligible product, they will earn 3X points under Camp_1 until the 50,000 cap is reached. After reaching the cap, any new eligible purchases will automatically earn 2X points under Camp_2.
Use Case 2: Reaching the Limit Mid-Transaction
-
Situation:
- The member has already earned 49,000 points from Camp_1.
- A new purchase generates 3X = 2,000 points under Camp_1.
-
System Behavior:
- Only 1,000 points can be awarded under Camp_1 (to reach exactly 50,000).
- The remaining 1,000 points will not be awarded under Camp_1 because the limit is reached.
- The order will not split the ratio; only the amount allowed up to the cap is awarded.
- From the next order onward, the system switches to Camp_2 (2X).
-
Result:
- Points awarded under Camp_1: 1,000
- Additional points beyond the cap: Not awarded
- Camp_1 is now closed for this member.
Use Case 3: Order Contains Products ABC, but Only AB Are Eligible
-
Situation:
- The order contains products A, B, and C (ABC).
- Only products A and B are eligible for the campaign (product C is excluded).
- Camp_1 limit has already been reached (50,000 points).
-
System Behavior:
- Since Camp_1 is closed, the system checks eligibility under Camp_2.
- Products A and B will earn 2X points under Camp_2.
- Product C earns no bonus points because it is excluded from Camp_2.
-
Result:
- Points awarded = 2X on products A + B
- No points awarded for product C
- Awarding follows Camp_2 rules, even if the order originally matched Camp_1 structure.
Campaign Group
The campaign group functionality allows you to manage multiple campaigns under one umbrella. It allows administrators to define a precedent rule for when a member qualifies for multiple campaigns in a single transaction.
For more information about campaign groups, please refer to the Campaign Group documentation.




















