Campaign Document (Data API 16.8)

(supports custom properties)

Document representing a campaign.

Property Type Constraints Description
campaign_id String maxLength=256, minLength=1 The ID of the campaign.
coupons [String]   The array of assigned coupon IDs, not sorted
customer_groups [String]   The array of assigned customer groups, not sorted
description String maxLength=4000, minLength=0 The description of the campaign.
enabled boolean   The enabled flag for campaign.
end_date DateTime   The date that the Scenario ends
link String   link for convenience
source_code_groups [String]   The array of assigned source code groups, not sorted
start_date DateTime   The date that the Scenario begins
X OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.