Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 2.41 KB

NewCampaign.md

File metadata and controls

26 lines (21 loc) · 2.41 KB

NewCampaign

Properties

Name Type Description Notes
name str A user-facing name for this campaign.
description str A detailed description of the campaign. [optional]
start_time datetime Timestamp when the campaign will become active. [optional]
end_time datetime Timestamp when the campaign will become inactive. [optional]
attributes object Arbitrary properties associated with this campaign. [optional]
state str A disabled or archived campaign is not evaluated for rules or coupons. [default to 'enabled']
active_ruleset_id int ID of Ruleset this campaign applies on customer session evaluation. [optional]
tags list[str] A list of tags for the campaign.
features list[str] The features enabled in this campaign.
coupon_settings CodeGeneratorSettings [optional]
referral_settings CodeGeneratorSettings [optional]
limits list[LimitConfig] The set of budget limits for this campaign.
campaign_groups list[int] The IDs of the campaign groups this campaign belongs to. [optional]
type str 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']
linked_store_ids list[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]
evaluation_group_id int The ID of the campaign evaluation group the campaign belongs to. [optional]

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