| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | |
| accountId | Long | ||
| applicationId | Long | ||
| campaignId | Long | ||
| created | OffsetDateTime | ||
| createdBy | Long | ||
| revisionId | Long | ||
| version | Long | ||
| name | String | A user-facing name for this 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] |
| description | String | A detailed description of the campaign. | [optional] |
| activeRulesetId | Integer | The ID of the ruleset this campaign will use. | [optional] |
| tags | List<String> | A list of tags for the campaign. | [optional] |
| couponSettings | CodeGeneratorSettings | [optional] | |
| referralSettings | CodeGeneratorSettings | [optional] | |
| limits | List<LimitConfig> | The set of limits that will operate for this campaign version. | [optional] |
| reevaluateOnReturn | Boolean | Indicates whether this campaign should be reevaluated when a customer returns an item. | [optional] |
| features | List<FeaturesEnum> | A list of features for the campaign. | [optional] |
| Name | Value |
|---|---|
| COUPONS | "coupons" |
| REFERRALS | "referrals" |
| LOYALTY | "loyalty" |
| GIVEAWAYS | "giveaways" |
| STRIKETHROUGH | "strikethrough" |
| ACHIEVEMENTS | "achievements" |