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. | [optional] [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[] | A list of features for the campaign. | |
couponSettings | \TalonOne\Client\Model\CodeGeneratorSettings | [optional] | |
referralSettings | \TalonOne\Client\Model\CodeGeneratorSettings | [optional] | |
limits | \TalonOne\Client\Model\LimitConfig[] | The set of limits that will operate for this campaign. | |
campaignGroups | int[] | The IDs of the campaign groups this campaign belongs to. | [optional] |
evaluationGroupId | int | The ID of the campaign evaluation group the 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. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional] |