CampaignsCreateGiftCampaign.md

VoucherifySdk::CampaignsCreateGiftCampaign

Properties

Name	Type	Description	Notes
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]
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]
join_once	Boolean	If this value is set to `true`, customers will be able to join the campaign only once.	[optional]
auto_join	Boolean	Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.	[optional]
use_voucher_metadata_schema	Boolean	Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.	[optional]
vouchers_count	Integer	Total number of unique vouchers in campaign (size of campaign).	[optional]
start_date	Time	Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.	[optional]
expiration_date	Time	Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.	[optional]
validity_timeframe	CampaignBaseValidityTimeframe		[optional]
validity_day_of_week	Array<Integer>	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]
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]
validation_rules	Array<String>	Array containing the ID of the validation rule associated with the promotion tier.	[optional]
category_id	String	Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.	[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]
campaign_type	String	Type of campaign.	[optional][default to 'GIFT_VOUCHERS']
voucher	GiftCampaignVoucher		[optional]