{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_type": {
"type": "string",
"description": "How the campaign's content is put together. The old drag and drop editor uses 'template' while the new editor uses 'multichannel'. Defaults to template.",
"enum": [
"template",
"multichannel"
]
},
"recipients": {
"type": "object",
"description": "List settings for the campaign.",
"properties": {
"list_id": {
"type": "string",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
}
},
"required": [
"list_id"
]
},
"rss_opts": {
"type": "object",
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign.",
"properties": {
"feed_url": {
"type": "string",
"description": "The URL for the RSS feed."
},
"frequency": {
"type": "string",
"description": "The frequency of the RSS Campaign.",
"enum": [
"daily",
"weekly",
"monthly"
]
},
"schedule": {
"type": "object",
"description": "The schedule for sending the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"required": [
"feed_url",
"frequency"
]
},
"settings": {
"type": "object",
"description": "The settings for your campaign, including subject, from name, reply-to address, and more.",
"properties": {
"subject_line": {
"type": "string",
"description": "The subject line for the campaign."
},
"preview_text": {
"type": "string",
"description": "The preview text for the campaign."
},
"title": {
"type": "string",
"description": "The title of the campaign."
},
"from_name": {
"type": "string",
"description": "The 'from' name on the campaign (not an email address)."
},
"reply_to": {
"type": "string",
"description": "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending."
},
"use_conversation": {
"type": "boolean",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
},
"to_name": {
"type": "string",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"folder_id": {
"type": "string",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"authenticate": {
"type": "boolean",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_footer": {
"type": "boolean",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"inline_css": {
"type": "boolean",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_tweet": {
"type": "boolean",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"fb_comments": {
"type": "boolean",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"description": "The id of the template to use."
}
}
},
"social_card": {
"type": "object",
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).",
"properties": {
"image_url": {
"type": "string",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"description": "A short summary of the campaign to display."
},
"title": {
"type": "string",
"description": "The title for the card. Typically the subject line of the campaign."
}
}
},
"tracking": {
"type": "object",
"description": "The tracking options for a campaign.",
"properties": {
"opens": {
"type": "boolean",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"html_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"description": "Whether to enable e-commerce tracking."
},
"google_analytics": {
"type": "string",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
},
"clicktale": {
"type": "string",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"description": "Deprecated"
},
"capsule": {
"type": "object",
"description": "Deprecated"
}
}
},
"type": {
"type": "string",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
},
"variate_settings": {
"type": "object",
"description": "The settings specific to A/B test campaigns.",
"properties": {
"winner_criteria": {
"type": "string",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application.",
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
]
},
"wait_time": {
"type": "integer",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"test_size": {
"type": "integer",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
}
},
"required": [
"winner_criteria"
]
}
},
"required": [
"PCID",
"type"
]
}
