Name | Type | Description | Notes |
---|---|---|---|
name | String | A user-facing name for this campaign. | |
description | String | A detailed description of the campaign. | [optional] |
startTime | OffsetDateTime | Timestamp when the campaign will become active. | [optional] |
endTime | OffsetDateTime | Timestamp when the campaign will become inactive. | [optional] |
attributes | Object | Arbitrary properties associated with this campaign. | [optional] |
state | StateEnum | A disabled or archived campaign is not evaluated for rules or coupons. | |
activeRulesetId | Integer | ID of Ruleset this campaign applies on customer session evaluation. | [optional] |
tags | List<String> | A list of tags for the campaign. | |
features | List<FeaturesEnum> | The features enabled in this campaign. | |
couponSettings | CodeGeneratorSettings | [optional] | |
referralSettings | CodeGeneratorSettings | [optional] | |
limits | List<LimitConfig> | The set of budget limits for this campaign. | |
campaignGroups | List<Integer> | The IDs of the campaign groups this campaign belongs to. | [optional] |
Name | Value |
---|---|
ENABLED | "enabled" |
DISABLED | "disabled" |
ARCHIVED | "archived" |
Name | Value |
---|---|
COUPONS | "coupons" |
REFERRALS | "referrals" |
LOYALTY | "loyalty" |
GIVEAWAYS | "giveaways" |
STRIKETHROUGH | "strikethrough" |