Response body schema for GET v1/campaigns/{campaignId}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Unique campaign ID, assigned by Voucherify. | [optional] |
| name | str | Campaign name. | [optional] |
| description | str | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
| campaign_type | str | Type of campaign. | [optional] |
| type | str | 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 - `STANDALONE`: campaign for single vouchers | [optional] |
| voucher | CampaignVoucher | [optional] | |
| auto_join | bool | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
| join_once | bool | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
| use_voucher_metadata_schema | bool | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
| validity_timeframe | ValidityTimeframe | [optional] | |
| validity_day_of_week | List[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] |
| validity_hours | ValidityHours | [optional] | |
| activity_duration_after_publishing | str | 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] |
| vouchers_count | int | Total number of unique vouchers in campaign. | [optional] |
| start_date | datetime | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. | [optional] |
| expiration_date | datetime | 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] |
| created_at | datetime | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
| updated_at | datetime | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
| category | str | Unique category name. | [optional] |
| creation_status | str | Indicates the status of the campaign creation. | [optional] |
| vouchers_generation_status | str | 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. | [optional] |
| protected | bool | Indicates whether the resource can be deleted. | [optional] |
| category_id | str | Unique category ID that this campaign belongs to. | [optional] |
| categories | List[Category] | Contains details about the category. | [optional] |
| object | str | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign'] |
| referral_program | ReferralProgram | [optional] | |
| loyalty_tiers_expiration | LoyaltyTiersExpirationAll | [optional] | |
| promotion | PromotionTiersList | [optional] | |
| validation_rules_assignments | ValidationRulesAssignmentsList | [optional] | |
| access_settings_assignments | AccessSettingsCampaignAssignmentsList | [optional] |