CampaignsResendAction200Response
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"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."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"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."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"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",
"title": "Plain-Text Click Tracking",
"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",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"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."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"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/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"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."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"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."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"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."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"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."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"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."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsResendActionRequest
{
"type": "object",
"properties": {
"shortcut_type": {
"enum": [
"to_non_openers",
"to_new_subscribers",
"to_non_clickers"
],
"type": "string",
"title": "Resend Shortcut Type",
"description": "Which campaign resend shortcut to use. Default is `to_non_openers`."
}
}
}
CampaignsResendActionResponse
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"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."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"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."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"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",
"title": "Plain-Text Click Tracking",
"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",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"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."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"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/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"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."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"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."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"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."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"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."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"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."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsResendActiondefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsResumeRssCampaignResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsResumeRssCampaigndefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsScheduleDeliveryRequest
{
"type": "object",
"required": [
"schedule_time"
],
"properties": {
"timewarp": {
"type": "boolean",
"title": "Timewarp",
"description": "Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/)."
},
"schedule_time": {
"type": "string",
"title": "Schedule Time",
"format": "date-time",
"description": "The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45)."
},
"batch_delivery": {
"type": "object",
"title": "Batch Delivery",
"required": [
"batch_delay",
"batch_count"
],
"properties": {
"batch_count": {
"type": "integer",
"title": "Batch Count",
"description": "The number of batches for the campaign send."
},
"batch_delay": {
"type": "integer",
"title": "Batch Delay",
"description": "The delay, in minutes, between batches."
}
},
"description": "Choose whether the campaign should use [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). Cannot be set to `true` for campaigns using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
}
}
}
CampaignsScheduleDeliveryResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsScheduleDeliverydefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsSendActionResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsSendActiondefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsSendTestEmailRequest
{
"type": "object",
"required": [
"test_emails",
"send_type"
],
"properties": {
"send_type": {
"enum": [
"html",
"plaintext"
],
"type": "string",
"title": "Type of email to test",
"description": "Choose the type of test email to send."
},
"test_emails": {
"type": "array",
"items": {
"type": "string"
},
"title": "Test Emails",
"description": "An array of email addresses to send the test email to."
}
}
}
CampaignsSendTestEmailResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsSendTestEmaildefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsSetContent200Response
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsSetContentRequest
{
"type": "object",
"title": "Campaign Content",
"properties": {
"url": {
"type": "string",
"title": "Campaign URL",
"description": "When importing a campaign, the URL where the HTML lives."
},
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"archive": {
"type": "object",
"title": "Upload Archive",
"required": [
"archive_content"
],
"properties": {
"archive_type": {
"enum": [
"zip",
"tar.gz",
"tar.bz2",
"tar",
"tgz",
"tbz"
],
"type": "string",
"title": "Archive Type",
"description": "The type of encoded file. Defaults to zip."
},
"archive_content": {
"type": "string",
"title": "Archive Content",
"description": "The base64-encoded representation of the archive file."
}
},
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/)."
},
"template": {
"type": "object",
"title": "Template Content",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"sections": {
"type": "object",
"title": "Template Sections",
"description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."
}
},
"description": "Use this template to generate the HTML content of the campaign"
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"required": [
"content_label"
],
"properties": {
"url": {
"type": "string",
"title": "Campaign URL",
"description": "When importing a campaign, the URL for the HTML."
},
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"archive": {
"type": "object",
"title": "Upload Archive",
"required": [
"archive_content"
],
"properties": {
"archive_type": {
"enum": [
"zip",
"tar.gz",
"tar.bz2",
"tar",
"tgz",
"tbz"
],
"type": "string",
"title": "Archive Type",
"description": "The type of encoded file. Defaults to zip."
},
"archive_content": {
"type": "string",
"title": "Archive Content",
"description": "The base64-encoded representation of the archive file."
}
},
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/)."
},
"template": {
"type": "object",
"title": "Template Content",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"sections": {
"type": "object",
"title": "Template Sections",
"description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."
}
},
"description": "Use this template to generate the HTML content for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"description": "The label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided."
}
},
"description": "The HTML and plain-text content for a campaign"
}
CampaignsSetContentResponse
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsSetContentdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsUnscheduleActionResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsUnscheduleActiondefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsUpdateFeedbackMessage200Response
{
"type": "object",
"title": "Campaign Feedback",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessageRequest
{
"type": "object",
"title": "Campaign Feedback",
"properties": {
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessageResponse
{
"type": "object",
"title": "Campaign Feedback",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessagedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
CampaignsUpdateSettings200Response
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"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."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"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."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"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",
"title": "Plain-Text Click Tracking",
"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",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"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."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"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/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"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."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"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."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"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."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"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."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"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."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsRequest
{
"type": "object",
"title": "Campaign",
"required": [
"settings"
],
"properties": {
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"required": [
"subject_line",
"from_name",
"reply_to"
],
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"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."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"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",
"title": "Plain-Text Click Tracking",
"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",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"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."
}
},
"description": "List settings for the campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"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/)."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"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."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"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."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"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."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"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."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"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."
}
},
"description": "The settings specific to A/B test campaigns."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsResponse
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"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."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"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."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"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",
"title": "Plain-Text Click Tracking",
"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",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"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."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"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/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"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."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"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."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"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."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"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."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"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."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesCreateNewMailchimpSite200Response
{
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSiteRequest
{
"type": "object",
"title": "Connected Site",
"required": [
"foreign_id",
"domain"
],
"properties": {
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The connected site domain."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "MC001",
"description": "The unique identifier for the site."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSiteResponse
{
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSitedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesGetInfo200Response
{
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesGetInfoResponse
{
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesGetInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesListAll200Response
{
"type": "object",
"title": "Connected Sites",
"properties": {
"sites": {
"type": "array",
"items": {
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
},
"title": "Connected Sites",
"description": "An array of objects, each representing a connected site."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of connected sites in the account."
}
ConnectedSitesListAllResponse
{
"type": "object",
"title": "Connected Sites",
"properties": {
"sites": {
"type": "array",
"items": {
"type": "object",
"title": "Connected Site",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
},
"title": "Connected Sites",
"description": "An array of objects, each representing a connected site."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of connected sites in the account."
}
ConnectedSitesListAlldefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesRemoveSiteResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesRemoveSitedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesVerifyScriptInstallationResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConnectedSitesVerifyScriptInstallationdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConversationsGetAllConversations200Response
{
"type": "object",
"title": "Tracked Conversations",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversations",
"description": "A list of conversations."
}
},
"description": "A collection of this account's tracked conversations."
}
ConversationsGetAllConversationsResponse
{
"type": "object",
"title": "Tracked Conversations",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversations",
"description": "A list of conversations."
}
},
"description": "A collection of this account's tracked conversations."
}
ConversationsGetAllConversationsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConversationsGetById200Response
{
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetByIdResponse
{
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetByIddefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ConversationsGetMessageById200Response
{
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetMessageByIdResponse
{
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}