Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 3.59 KB

CampaignsUpdateRequestBody.md

File metadata and controls

27 lines (24 loc) · 3.59 KB

# CampaignsUpdateRequestBody

Properties

Name Type Description Notes
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]
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 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]
unsetMetadataFields string[] Determine which metadata should be removed from campaign. [optional]
categoryId string Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. [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]
joinOnce 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]
autoJoin 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. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. [optional]
discount \OpenAPI\Client\Model\Discount [optional]
referralProgram \OpenAPI\Client\Model\ReferralProgram [optional]
gift \OpenAPI\Client\Model\Gift [optional]
loyaltyTiersExpiration \OpenAPI\Client\Model\LoyaltyTiersExpirationAll [optional]
options \OpenAPI\Client\Model\CampaignsUpdateRequestBodyOptions [optional]

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