Skip to content

Latest commit

 

History

History
67 lines (34 loc) · 2.75 KB

NewCampaign.md

File metadata and controls

67 lines (34 loc) · 2.75 KB
Raw

TalonOne.NewCampaign

Properties

Name Type Description Notes
name String A user-facing name for this campaign.
description String A detailed description of the campaign. [optional]
startTime Date Timestamp when the campaign will become active. [optional]
endTime Date Timestamp when the campaign will become inactive. [optional]
attributes Object Arbitrary properties associated with this campaign. [optional]
state String A disabled or archived campaign is not evaluated for rules or coupons. [default to 'enabled']
activeRulesetId Number ID of Ruleset this campaign applies on customer session evaluation. [optional]
tags [String] A list of tags for the campaign.
features [String] The features enabled in this campaign.
couponSettings CodeGeneratorSettings [optional]
referralSettings CodeGeneratorSettings [optional]
limits [LimitConfig] The set of budget limits for this campaign.
campaignGroups [Number] The IDs of the campaign groups this campaign belongs to. [optional]
type 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']
linkedStoreIds [Number] A list of store IDs that you want to link to the campaign. Note: Campaigns with linked store IDs will only be evaluated when there is a customer session update that references a linked store. [optional]
evaluationGroupId Number The ID of the campaign evaluation group the campaign belongs to. [optional]

Enum: StateEnum

  • enabled (value: "enabled")

  • disabled (value: "disabled")

  • archived (value: "archived")

Enum: [FeaturesEnum]

  • coupons (value: "coupons")

  • referrals (value: "referrals")

  • loyalty (value: "loyalty")

  • giveaways (value: "giveaways")

  • strikethrough (value: "strikethrough")

  • achievements (value: "achievements")

Enum: TypeEnum

  • cartItem (value: "cartItem")

  • advanced (value: "advanced")