Skip to content

Latest commit

 

History

History
68 lines (35 loc) · 2.85 KB

UpdateCampaignTemplate.md

File metadata and controls

68 lines (35 loc) · 2.85 KB
Raw

TalonOne.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 String Only campaign templates in 'available' state may be used to create campaigns.
activeRulesetId Number The ID of the ruleset this campaign template will use. [optional]
tags [String] A list of tags for the campaign template. [optional]
features [String] A list of features for the campaign template. [optional]
couponSettings CodeGeneratorSettings [optional]
referralSettings CodeGeneratorSettings [optional]
limits [TemplateLimitConfig] The set of limits that operate for this campaign template. [optional]
templateParams [CampaignTemplateParams] Fields which can be used to replace values in a rule. [optional]
applicationsIds [Number] A list of IDs of the Applications that are subscribed to this campaign template.
campaignCollections [CampaignTemplateCollection] The campaign collections from the blueprint campaign for the template. [optional]
defaultCampaignGroupId Number The default campaign group ID. [optional]
campaignType String 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. [optional] [default to 'advanced']

Enum: StateEnum

  • draft (value: "draft")

  • enabled (value: "enabled")

  • disabled (value: "disabled")

Enum: [FeaturesEnum]

  • coupons (value: "coupons")

  • referrals (value: "referrals")

  • loyalty (value: "loyalty")

  • giveaways (value: "giveaways")

  • strikethrough (value: "strikethrough")

  • achievements (value: "achievements")

Enum: CampaignTypeEnum

  • cartItem (value: "cartItem")

  • advanced (value: "advanced")