ListsGetWebhookInfoResponse
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsGetWebhookInfodefaultResponse
{
"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'."
}
ListsGetWebhooksInfo200Response
{
"type": "object",
"title": "List 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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
},
"title": "Webhooks",
"description": "An array of objects, each representing a specific list member."
},
"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 a specific list."
}
ListsGetWebhooksInfoResponse
{
"type": "object",
"title": "List 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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
},
"title": "Webhooks",
"description": "An array of objects, each representing a specific list member."
},
"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 a specific list."
}
ListsGetWebhooksInfodefaultResponse
{
"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'."
}
ListsListCategoryInterests200Response
{
"type": "object",
"title": "Interests",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id that the interests belong to."
},
"interests": {
"type": "array",
"items": {
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
},
"title": "Interests",
"description": "An array of this category's interests"
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"description": "The id for the interest category."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of this category's interests"
}
ListsListCategoryInterestsResponse
{
"type": "object",
"title": "Interests",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id that the interests belong to."
},
"interests": {
"type": "array",
"items": {
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
},
"title": "Interests",
"description": "An array of this category's interests"
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"description": "The id for the interest category."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of this category's interests"
}
ListsListCategoryInterestsdefaultResponse
{
"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'."
}
ListsListInterestCategories200Response
{
"type": "object",
"title": "Interest Groupings",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this category belongs to."
},
"categories": {
"type": "array",
"items": {
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
},
"title": "Interest Categories",
"description": "This array contains individual interest categories."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Information about this list's interest categories."
}
ListsListInterestCategoriesResponse
{
"type": "object",
"title": "Interest Groupings",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this category belongs to."
},
"categories": {
"type": "array",
"items": {
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
},
"title": "Interest Categories",
"description": "This array contains individual interest categories."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Information about this list's interest categories."
}
ListsListInterestCategoriesdefaultResponse
{
"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'."
}
ListsListMergeFields200Response
{
"type": "object",
"title": "Collection of Merge Fields",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"merge_fields": {
"type": "array",
"items": {
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"title": "Merge Fields",
"description": "An array of objects, each representing a merge field resource."
}
},
"description": "The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsListMergeFieldsResponse
{
"type": "object",
"title": "Collection of Merge Fields",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"merge_fields": {
"type": "array",
"items": {
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"title": "Merge Fields",
"description": "An array of objects, each representing a merge field resource."
}
},
"description": "The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsListMergeFieldsdefaultResponse
{
"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'."
}
ListsListTopEmailClients200Response
{
"type": "object",
"title": "Email Clients",
"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."
},
"clients": {
"type": "array",
"items": {
"type": "object",
"title": "Email Client",
"properties": {
"client": {
"type": "string",
"title": "Client",
"readOnly": true,
"description": "The name of the email client."
},
"members": {
"type": "integer",
"title": "Members",
"readOnly": true,
"description": "The number of subscribed members who used this email client."
}
},
"description": "The email client."
},
"title": "Email Clients",
"description": "An array of top email clients."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The top email clients based on user-agent strings."
}
ListsListTopEmailClientsResponse
{
"type": "object",
"title": "Email Clients",
"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."
},
"clients": {
"type": "array",
"items": {
"type": "object",
"title": "Email Client",
"properties": {
"client": {
"type": "string",
"title": "Client",
"readOnly": true,
"description": "The name of the email client."
},
"members": {
"type": "integer",
"title": "Members",
"readOnly": true,
"description": "The number of subscribed members who used this email client."
}
},
"description": "The email client."
},
"title": "Email Clients",
"description": "An array of top email clients."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The top email clients based on user-agent strings."
}
ListsListTopEmailClientsdefaultResponse
{
"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'."
}
ListsRemoveMemberFromSegmentResponse
{
"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'."
}
ListsRemoveMemberFromSegmentdefaultResponse
{
"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'."
}
ListsRemoveMemberPermanentResponse
{
"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'."
}
ListsRemoveMemberPermanentdefaultResponse
{
"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'."
}
ListsSearchTagsByName200Response
{
"type": "object",
"title": "Tag search results",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
}
}
},
"title": "Tags",
"readOnly": true,
"description": "A list of matching tags."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of tags matching the input query."
}
ListsSearchTagsByNameResponse
{
"type": "object",
"title": "Tag search results",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
}
}
},
"title": "Tags",
"readOnly": true,
"description": "A list of matching tags."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of tags matching the input query."
}
ListsSearchTagsByNamedefaultResponse
{
"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'."
}
ListsUpdateInterestCategory200Response
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsUpdateInterestCategoryInterest200Response
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsUpdateInterestCategoryInterestResponse
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsUpdateInterestCategoryInterestdefaultResponse
{
"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'."
}
ListsUpdateInterestCategoryResponse
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsUpdateInterestCategorydefaultResponse
{
"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'."
}
ListsUpdateMember200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberRequest
{
"type": "object",
"title": "Add List Members",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"description": "IP address the subscriber signed up from."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberdefaultResponse
{
"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'."
}
ListsUpdateMergeField200Response
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFieldRequest
{
"type": "object",
"title": "Merge Field",
"required": [
"name"
],
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for members to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "Whether the merge field is required to import a contact."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFieldResponse
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFielddefaultResponse
{
"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'."
}
ListsUpdateNoteSpecificListMember200Response
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsUpdateNoteSpecificListMemberResponse
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsUpdateNoteSpecificListMemberdefaultResponse
{
"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'."
}
ListsUpdateSegmentById200Response
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "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)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsUpdateSegmentByIdRequest
{
"type": "object",
"title": "List",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"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)."
},
"title": "Segment Conditions",
"description": "An array of segment conditions."
}
},
"description": "The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions."
},
"static_segment": {
"type": "array",
"items": {
"type": "string"
},
"title": "Static Segment",
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field."
}
},
"description": "Information about a specific list segment."
}
ListsUpdateSegmentByIdResponse
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "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)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsUpdateSegmentByIddefaultResponse
{
"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'."
}
ListsUpdateSettings200Response
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsRequest
{
"type": "object",
"title": "Subscriber List",
"required": [
"name",
"permission_reminder",
"email_type_option",
"contact",
"campaign_defaults"
],
"properties": {
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"contact": {
"type": "object",
"title": "List Contact",
"required": [
"company",
"address1",
"city",
"state",
"zip",
"country"
],
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"required": [
"from_name",
"from_email",
"subject",
"language"
],
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsResponse
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsdefaultResponse
{
"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'."
}
ListsUpdateWebhookSettings200Response
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}