Name | Type | Description |
---|---|---|
id | String | Unique campaign ID. |
startDate | OffsetDateTime | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. |
expirationDate | OffsetDateTime | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. |
validityTimeframe | ValidityTimeframe | |
validityDayOfWeek | List<ValidityDayOfWeekEnum> | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |
validityHours | ValidityHours | |
active | Boolean | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- Disable Campaign -->Disable Campaign endpoint. - `true` indicates an active campaign - `false` indicates an inactive campaign |
categoryId | String | Unique category ID that this campaign belongs to. |
_object | String | The type of the object represented by the campaign object. This object stores information about the campaign. |
Name | Value |
---|---|
NUMBER_0 | 0 |
NUMBER_1 | 1 |
NUMBER_2 | 2 |
NUMBER_3 | 3 |
NUMBER_4 | 4 |
NUMBER_5 | 5 |
NUMBER_6 | 6 |