| Field | Guidance | Relevancy |
|---|---|---|
| ID | A unique merchant-defined ID assigned to the Campaign. Note: - IDs are defined once for each campaign and can’t be edited or changed. - A cloned campaign will require a new unique ID. | Required |
| Name | Enter a meaningful name for the campaign. | Required |
| Description | A short description of the campaign | Optional |
| Subscriptions | Toggle to define whether the campaign discount is relevant for new subscriptions or for both new and existing subscriptions. Toggle right to apply to New subscriptions or left for Any. By default, set to Any. | Required |
| Type | Select from the drop-down list what type of campaign you’re creating:- Promotion Campaign: Allows you to define a single Campaign code that can be distributed to multiple customers. A promotion code is not unique to individual users and is typically publicly available through mass distribution. - Coupon Campaign: Allows you to generate multiple unique Campaign codes. Coupon Campaigns are often highly targeted, the unique 16 characters alphanumeric coupon code is offered directly to a specific customer. Coupon codes are generated by the system based on prefix input from you and can be defined as single-use codes, for which redemption is allowed only once for every unique code, or multi-use codes, for which the number of allowed redemptions of each code is defined. | Required |
| Coupon Campaign > Lock Coupon Codes | Toggle to define whether the coupon codes generated by the system require an additional security measure of activation through the API. Toggle right for Yes, coupon codes are locked and require activation or left for No, the generated coupon codes will be immediately active. By default, set to No. | Optional |
| Coupon Campaign > Max Redemptions | The maximum number of times a single coupon code can be redeemed. | Required |
| Start and End Date | Specify the discount offer period during which a customer can submit a Campaign Code and redeem the discount. The discount period itself can extend beyond the end date. | Required |
| Start Time and End Time | Specify from what hour and minutes and until what hour and minute the Campaign Code can be redeemed. These fields allow you to create single day campaigns. | Optional |
| Parent topic:Working with Campaigns |