Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.54 KB

UpdateCampaignTemplate.md

File metadata and controls

49 lines (34 loc) · 2.54 KB

UpdateCampaignTemplate

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.
activeRulesetId Integer The ID of the ruleset this campaign template will use. [optional]
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]
referralSettings CodeGeneratorSettings [optional]
limits List<TemplateLimitConfig> The set of limits that operate for this campaign template. [optional]
templateParams List<CampaignTemplateParams> Fields which can be used to replace values in a rule. [optional]
applicationsIds List<Integer> A list of IDs of the Applications that are subscribed to this campaign template.
campaignCollections List<CampaignTemplateCollection> The campaign collections from the blueprint campaign for the template. [optional]
defaultCampaignGroupId Integer The default campaign group ID. [optional]

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"