Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 4.88 KB

CampaignBase.md

File metadata and controls

38 lines (35 loc) · 4.88 KB
Raw

# CampaignBase

Properties

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 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 \OpenAPI\Client\Model\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 standalone voucher 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 \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]
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 \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]
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 \DateTime Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. [optional]
updatedAt \DateTime 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. [optional]
protected bool Indicates whether the resource can be deleted. [optional]
categoryId string Unique category ID that this campaign belongs to. [optional]
categories \OpenAPI\Client\Model\Category[] Contains details about the category. [optional]
object string The type of the object represented by JSON. This object stores information about the campaign. [optional] [default to 'campaign']
referralProgram \OpenAPI\Client\Model\ReferralProgram [optional]
loyaltyTiersExpiration \OpenAPI\Client\Model\LoyaltyTiersExpirationAll [optional]

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