Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 3.4 KB

CampaignsUpdateRequestBody.md

File metadata and controls

29 lines (26 loc) · 3.4 KB

# CampaignsUpdateRequestBody

Properties

Name Type Description Notes
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 \OpenAPI\Client\Model\CampaignsUpdateRequestBodyValidityTimeframe [optional]
validity_day_of_week int[] Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday [optional]
description string An optional field to keep any extra textual information about the campaign such as a campaign description and details. [optional]
category string The category assigned to the campaign. Either pass this parameter OR the `category_id`. [optional]
metadata object [optional]
unset_metadata_fields string[] Determine which metadata should be removed from campaign. [optional]
category_id string Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. [optional]
activity_duration_after_publishing 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. [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]
type string 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. [optional]
discount object [optional]
referral_program \OpenAPI\Client\Model\ReferralProgram [optional]
gift \OpenAPI\Client\Model\Gift [optional]
loyalty_tiers_expiration \OpenAPI\Client\Model\LoyaltyTiersExpirationAll [optional]
options \OpenAPI\Client\Model\CampaignsUpdateRequestBodyOptions [optional]
winners_count string It represents the total number of winners in a lucky draw. [optional]
unique_winners_per_draw string It indicates whether each winner in a draw is unique or not. [optional]
unique_winners string Specifies whether each participant can win only once across multiple draws. [optional]

[Back to Model list] [Back to API list] [Back to README]