| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | Campaign name. | [optional] |
| description | string | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
| type | string | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published | [optional] |
| joinOnce | bool | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
| autoJoin | bool | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
| useVoucherMetadataSchema | bool | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
| vouchersCount | int | Total number of unique vouchers in campaign (size of campaign). | [optional] |
| startDate | \DateTime | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. | [optional] |
| expirationDate | \DateTime | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. | [optional] |
| validityTimeframe | \OpenAPI\Client\Model\ValidityTimeframe | [optional] | |
| validityDayOfWeek | int[] | 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 | [optional] |
| validityHours | \OpenAPI\Client\Model\ValidityHours | [optional] | |
| activityDurationAfterPublishing | string | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
| categoryId | string | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
| category | string | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
| metadata | object | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
| validationRules | string[] | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
| campaignType | string | [optional] | |
| voucher | \OpenAPI\Client\Model\CampaignsCreateRequestBodyVoucher | [optional] | |
| referralProgram | \OpenAPI\Client\Model\ReferralProgram | [optional] | |
| promotion | \OpenAPI\Client\Model\CampaignsCreateRequestBodyPromotion | [optional] |