AutomationsListQueueEmailsResponse
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber queue for an email in an Automation workflow."
},
"_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."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "An automation workflow"
}
AutomationsListQueueEmailsdefaultResponse
{
"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'."
}
AutomationsListSummary200Response
{
"type": "object",
"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."
},
"automations": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation'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 Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's 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 a subscriber's email address."
},
"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 Automation. Defaults to `true`."
},
"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 Automation. Defaults to `true`."
},
"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 the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"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."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"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."
},
"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": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
},
"title": "Automation Workflows",
"description": "An array of objects, each representing an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an Automation workflow."
}
AutomationsListSummaryResponse
{
"type": "object",
"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."
},
"automations": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation'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 Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's 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 a subscriber's email address."
},
"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 Automation. Defaults to `true`."
},
"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 Automation. Defaults to `true`."
},
"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 the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"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."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"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."
},
"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": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
},
"title": "Automation Workflows",
"description": "An array of objects, each representing an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an Automation workflow."
}
AutomationsListSummarydefaultResponse
{
"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'."
}
AutomationsPauseAutomatedEmailResponse
{
"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'."
}
AutomationsPauseAutomatedEmaildefaultResponse
{
"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'."
}
AutomationsPauseWorkflowEmailsResponse
{
"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'."
}
AutomationsPauseWorkflowEmailsdefaultResponse
{
"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'."
}
AutomationsRemoveSubscriberFromWorkflow200Response
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsRemoveSubscriberFromWorkflowResponse
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsRemoveSubscriberFromWorkflowdefaultResponse
{
"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'."
}
AutomationsStartAllEmailsResponse
{
"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'."
}
AutomationsStartAllEmailsdefaultResponse
{
"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'."
}
AutomationsStartAutomatedEmailResponse
{
"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'."
}
AutomationsStartAutomatedEmaildefaultResponse
{
"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'."
}
AutomationsUpdateWorkflowEmail200Response
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"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 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."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"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`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"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 [Click Tale](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 a subscriber's email address."
},
"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`."
},
"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`."
},
"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",
"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/getting-started-with-groups/) 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."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"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/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"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."
},
"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."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmailRequest
{
"type": "object",
"title": "Update information about a specific workflow email",
"properties": {
"delay": {
"type": "object",
"title": "Automation Delay",
"required": [
"action"
],
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"example": "day",
"description": "The type of delay for an automation email."
},
"action": {
"enum": [
"signup",
"ecomm_abandoned_browse",
"ecomm_abandoned_cart"
],
"type": "string",
"title": "Delay Action",
"example": "signup",
"description": "The action that triggers the delay of an automation emails."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"example": 1,
"description": "The delay amount for an automation email."
},
"direction": {
"enum": [
"after"
],
"type": "string",
"title": "Delay Direction",
"example": "after",
"description": "Whether the delay settings describe before or after the delay action of an automation email."
}
},
"description": "The delay settings for an automation email."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"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."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
}
},
"description": "Update information about an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmailResponse
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"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 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."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"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`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"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 [Click Tale](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 a subscriber's email address."
},
"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`."
},
"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`."
},
"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",
"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/getting-started-with-groups/) 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."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"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/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"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."
},
"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."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmaildefaultResponse
{
"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'."
}
BatchWebhooksAddWebhook200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksAddWebhookRequest
{
"type": "object",
"title": "Batch Webhook",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the webhook receives requests or not."
}
},
"description": "Add a new Batch Webook."
}
BatchWebhooksAddWebhookResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksAddWebhookdefaultResponse
{
"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'."
}
BatchWebhooksGetInfo200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksGetInfoResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksGetInfodefaultResponse
{
"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'."
}
BatchWebhooksListWebhooks200Response
{
"type": "object",
"title": "Batch Webhooks",
"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."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
},
"title": "Webhooks",
"description": "An array of objects, each representing a Batch Webhook."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for batch requests."
}
BatchWebhooksListWebhooksResponse
{
"type": "object",
"title": "Batch Webhooks",
"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."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
},
"title": "Webhooks",
"description": "An array of objects, each representing a Batch Webhook."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for batch requests."
}
BatchWebhooksListWebhooksdefaultResponse
{
"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'."
}
BatchWebhooksRemoveWebhookResponse
{
"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'."
}
BatchWebhooksRemoveWebhookdefaultResponse
{
"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'."
}
BatchWebhooksUpdateWebhook200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksUpdateWebhookRequest
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the webhook receives requests or not."
}
},
"description": "Update an existing Batch Webook."
}
BatchWebhooksUpdateWebhookResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksUpdateWebhookdefaultResponse
{
"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'."
}
BatchesGetOperationStatus200Response
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesGetOperationStatusResponse
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesGetOperationStatusdefaultResponse
{
"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'."
}
BatchesListRequestsSummary200Response
{
"type": "object",
"title": "Batch Operations",
"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."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
},
"title": "Batches",
"description": "An array of objects representing batch calls."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of batch requests that have been made."
}
BatchesListRequestsSummaryResponse
{
"type": "object",
"title": "Batch Operations",
"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."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
},
"title": "Batches",
"description": "An array of objects representing batch calls."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of batch requests that have been made."
}
BatchesListRequestsSummarydefaultResponse
{
"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'."
}
BatchesStartOperationProcess200Response
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesStartOperationProcessRequest
{
"type": "object",
"required": [
"operations"
],
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"title": "Operations",
"required": [
"method",
"path"
],
"properties": {
"body": {
"type": "string",
"title": "Body",
"example": "{\"title\":\"Test\"}",
"description": "A string containing the JSON body to use with the request."
},
"path": {
"type": "string",
"title": "Path",
"example": "/lists",
"description": "The relative path to use for the operation."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string",
"title": "HTTP Method",
"example": "POST",
"description": "The HTTP method to use for the operation."
},
"params": {
"type": "object",
"title": "Query Parameters",
"example": "{\"count\":10,\"offset\":0}",
"description": "Any request query parameters. Example parameters: {\"count\":10, \"offset\":0}"
},
"operation_id": {
"type": "string",
"title": "Operation ID",
"example": "my-id-123",
"description": "An optional client-supplied id returned with the operation results."
}
}
},
"title": "Operations List",
"description": "An array of objects that describes operations to perform."
}
}
}
BatchesStartOperationProcessResponse
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesStartOperationProcessdefaultResponse
{
"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'."
}
BatchesStopRequestResponse
{
"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'."
}
BatchesStopRequestdefaultResponse
{
"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'."
}
CampaignFoldersAddNewFolder200Response
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in the folder."
},
"_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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersAddNewFolderRequest
{
"type": "object",
"title": "Campaign Folder",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Folder Name",
"description": "Name to associate with the folder."
}
},
"description": "A folder used to organize campaigns."
}