NewCampaignTemplate.md

NewCampaignTemplate

Properties

Name	Type	Description	Notes
name	String	The campaign template name.
description	String	Customer-facing text that explains the objective of the template.
instructions	String	Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign.
campaignAttributes	Object	The campaign attributes that campaigns created from this template will have by default.	[optional]
couponAttributes	Object	The campaign attributes that coupons created from this template will have by default.	[optional]
state	StateEnum	Only Campaign Templates in 'available' state may be used to create Campaigns.
tags	List<String>	A list of tags for the campaign template.	[optional]
features	List<FeaturesEnum>	A list of features for the campaign template.	[optional]
couponSettings	CodeGeneratorSettings		[optional]
couponReservationSettings	CampaignTemplateCouponReservationSettings		[optional]
referralSettings	CodeGeneratorSettings		[optional]
limits	List<TemplateLimitConfig>	The set of limits that will operate for this campaign template.	[optional]
templateParams	List<CampaignTemplateParams>	Fields which can be used to replace values in a rule.	[optional]
campaignCollections	List<CampaignTemplateCollection>	The campaign collections from the blueprint campaign for the template.	[optional]
defaultCampaignGroupId	Integer	The default campaign group ID.	[optional]
campaignType	CampaignTypeEnum	The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.

Enum: StateEnum

Name	Value
DRAFT	"draft"
ENABLED	"enabled"
DISABLED	"disabled"

Enum: List<FeaturesEnum>

Name	Value
COUPONS	"coupons"
REFERRALS	"referrals"
LOYALTY	"loyalty"
GIVEAWAYS	"giveaways"
STRIKETHROUGH	"strikethrough"
ACHIEVEMENTS	"achievements"

Enum: CampaignTypeEnum

Name	Value
CARTITEM	"cartItem"
ADVANCED	"advanced"