Request body schema for POST /loyalties.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
| 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 | [optional] |
| join_once | bool | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
| auto_join | bool | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [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] |
| vouchers_count | int | Total number of unique vouchers in campaign (size of 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] |
| 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] |
| category_id | str | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
| category | str | 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] |
| validation_rules | List[str] | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
| campaign_type | str | Type of campaign. | [optional] [default to 'LOYALTY_PROGRAM'] |
| voucher | CampaignLoyaltyVoucher | [optional] |