Name | Type | Description | Notes |
---|---|---|---|
name | String | A friendly name for this campaign. | |
description | String | A detailed description of the campaign. | [optional] |
startTime | Date | Datetime when the campaign will become active. | [optional] |
endTime | Date | Datetime when the campaign will become in-active. | [optional] |
attributes | Object | Arbitrary properties associated with this campaign | [optional] |
state | String | A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to 'enabled'] |
activeRulesetId | Number | ID of Ruleset this campaign applies on customer session evaluation. | [optional] |
tags | [String] | A list of tags for the campaign. | |
features | [String] | A list of features for the campaign. | |
couponSettings | CodeGeneratorSettings | [optional] | |
referralSettings | CodeGeneratorSettings | [optional] | |
limits | [LimitConfig] | The set of limits that will operate for this campaign |
-
enabled
(value:"enabled"
) -
disabled
(value:"disabled"
) -
archived
(value:"archived"
)
-
coupons
(value:"coupons"
) -
referrals
(value:"referrals"
) -
loyalty
(value:"loyalty"
)