Response body schema for POST v1/campaigns/{campaignId}.
| Name | Type | Description | Notes |
|---|---|---|---|
| Id | string | Unique campaign ID, assigned by Voucherify. | [optional] |
| 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] |
| CampaignType | string | Type of campaign. | [optional] |
| Type | string | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
| Voucher | CampaignVoucher | [optional] | |
| AutoJoin | bool? | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
| JoinOnce | bool? | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] |
| UseVoucherMetadataSchema | bool? | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
| ValidityTimeframe | ValidityTimeframe | [optional] | |
| ValidityDayOfWeek | List<CampaignsCreateResponseBody.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 | [optional] |
| ValidityHours | 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] |
| VouchersCount | int? | Total number of unique vouchers in campaign. | [optional] |
| StartDate | DateTimeOffset? | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. | [optional] |
| ExpirationDate | DateTimeOffset? | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. | [optional] |
| Active | bool? | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an active campaign - `false` indicates an inactive campaign | [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] |
| CreatedAt | DateTimeOffset? | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
| UpdatedAt | DateTimeOffset? | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
| Category | string | Unique category name. | [optional] |
| CreationStatus | string | Indicates the status of the campaign creation. | [optional] |
| VouchersGenerationStatus | string | Indicates the status of the campaign's voucher generation. | [optional] |
| Readonly | bool? | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the GET Campaign summary endpoint. | [optional] |
| Protected | bool? | Indicates whether the resource can be deleted. | [optional] |
| CategoryId | string | Unique category ID that this campaign belongs to. | [optional] |
| Categories | List<Category> | Contains details about the campaign category. For the GET List campaigns endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET Campaign summary endpoint, it is always returned as an empty array. | [optional] |
| Object | string | The type of the object represented by JSON. This object stores information about the campaign. | [optional] |
| ReferralProgram | ReferralProgram | [optional] | |
| LoyaltyTiersExpiration | LoyaltyTiersExpirationAll | [optional] | |
| AccessSettingsAssignments | AccessSettingsCampaignAssignmentsList | [optional] | |
| Promotion | PromotionTiersList | [optional] | |
| ValidationRulesAssignments | ValidationRulesAssignmentsList | [optional] |