Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 2.4 KB

BaseCampaign.md

File metadata and controls

25 lines (20 loc) · 2.4 KB

# BaseCampaign

Properties

Name Type Description Notes
name string A user-facing name for this campaign.
description string A detailed description of the campaign. [optional]
startTime \DateTime Timestamp when the campaign will become active. [optional]
endTime \DateTime 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 int 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 \TalonOne\Client\Model\CodeGeneratorSettings [optional]
referralSettings \TalonOne\Client\Model\CodeGeneratorSettings [optional]
limits \TalonOne\Client\Model\LimitConfig[] The set of budget limits for this campaign.
campaignGroups int[] 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 int[] 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]

[Back to Model list] [Back to API list] [Back to README]