| Name | Type | Description |
|---|---|---|
| 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 | |
| description | String | An optional field to keep any extra textual information about the campaign such as a campaign description and details. |
| category | String | The category assigned to the campaign. Either pass this parameter OR the `category_id`. |
| metadata | Object | |
| unsetMetadataFields | List<String> | Determine which metadata should be removed from campaign. |
| categoryId | String | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. |
| activityDurationAfterPublishing | String | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. |
| joinOnce | Boolean | If this value is set to `true`, customers will be able to join the campaign only once. |
| autoJoin | Boolean | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |
| type | TypeEnum | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. |
| discount | Object | |
| referralProgram | ReferralProgram | |
| gift | Gift | |
| loyaltyTiersExpiration | LoyaltyTiersExpirationAll | |
| options | CampaignsUpdateRequestBodyOptions | |
| winnersCount | String | It represents the total number of winners in a lucky draw. |
| uniqueWinnersPerDraw | String | It indicates whether each winner in a draw is unique or not. |
| uniqueWinners | String | Specifies whether each participant can win only once across multiple draws. |
| Name | Value |
|---|---|
| NUMBER_0 | 0 |
| NUMBER_1 | 1 |
| NUMBER_2 | 2 |
| NUMBER_3 | 3 |
| NUMBER_4 | 4 |
| NUMBER_5 | 5 |
| NUMBER_6 | 6 |
| Name | Value |
|---|---|
| AUTO_UPDATE | "AUTO_UPDATE" |
| STATIC | "STATIC" |