ListsBatchSubscribeOrUnsubscribeRequest
{
"type": "object",
"title": "Members to Subscribe/Unsubscribe to/from a List in batch",
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"items": {
"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",
"transactional"
],
"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."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "List Members",
"description": "An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call."
},
"sync_tags": {
"type": "boolean",
"title": "Sync Tags",
"description": "Whether this batch operation will replace all existing tags with tags in request."
},
"update_existing": {
"type": "boolean",
"title": "Update Existing Members",
"description": "Whether this batch operation will change existing members' subscription status."
}
},
"description": "Members to subscribe to or unsubscribe from a list."
}
ListsBatchSubscribeOrUnsubscribeResponse
{
"type": "object",
"title": "Batch update List members",
"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."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"title": "Error message",
"description": "The error message indicating why the email address could not be added or updated."
},
"field": {
"type": "string",
"title": "Field",
"description": "If the error is field-related, information about which field is at issue."
},
"error_code": {
"enum": [
"ERROR_CONTACT_EXISTS",
"ERROR_GENERIC"
],
"type": "string",
"title": "Error code",
"description": "A unique code that identifies this specifc error."
},
"email_address": {
"type": "string",
"title": "Member Email address",
"description": "The email address that could not be added or updated."
},
"field_message": {
"type": "string",
"title": "Field message",
"description": "Message indicating how to resolve a field-related error."
}
}
},
"title": "Errors",
"description": "An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details."
},
"error_count": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"new_members": {
"type": "array",
"items": {
"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": "The tags applied to this member."
},
"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."
}
},
"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."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"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."
},
"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."
},
"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."
},
"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": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"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."
},
"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."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "New members",
"description": "An array of objects, each representing a new member that was added to the list."
},
"total_created": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"total_updated": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"updated_members": {
"type": "array",
"items": {
"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": "The tags applied to this member."
},
"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."
}
},
"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."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"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."
},
"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."
},
"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."
},
"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": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"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."
},
"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."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Updated Members",
"description": "An array of objects, each representing an existing list member whose subscription status was updated."
}
},
"description": "Batch update list members."
}
ListsBatchSubscribeOrUnsubscribedefaultResponse
{
"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'."
}
ListsCreateNewList200Response
{
"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."
}
ListsCreateNewListRequest
{
"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",
"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."
}
ListsCreateNewListResponse
{
"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."
}
ListsCreateNewListdefaultResponse
{
"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'."
}
ListsCreateWebhook200Response
{
"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."
}
ListsCreateWebhookRequest
{
"type": "object",
"title": "Add Webhook",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"events": {
"type": "object",
"title": "Events",
"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."
},
"sources": {
"type": "object",
"title": "Sources",
"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": "Configure a webhook for the given list."
}
ListsCreateWebhookResponse
{
"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."
}
ListsCreateWebhookdefaultResponse
{
"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'."
}
ListsCustomizeSignupForm200Response
{
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormRequest
{
"type": "object",
"title": "Signup Form",
"properties": {
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormResponse
{
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormdefaultResponse
{
"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'."
}
ListsDeleteInterestCategoryResponse
{
"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'."
}
ListsDeleteInterestCategorydefaultResponse
{
"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'."
}
ListsDeleteInterestInCategoryResponse
{
"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'."
}
ListsDeleteInterestInCategorydefaultResponse
{
"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'."
}
ListsDeleteListResponse
{
"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'."
}
ListsDeleteListdefaultResponse
{
"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'."
}
ListsDeleteMergeFieldResponse
{
"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'."
}
ListsDeleteMergeFielddefaultResponse
{
"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'."
}
ListsDeleteNoteResponse
{
"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'."
}
ListsDeleteNotedefaultResponse
{
"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'."
}
ListsDeleteSegmentResponse
{
"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'."
}
ListsDeleteSegmentdefaultResponse
{
"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'."
}
ListsDeleteWebhookResponse
{
"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'."
}
ListsDeleteWebhookdefaultResponse
{
"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'."
}
ListsGetAbuseReport200Response
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAbuseReportResponse
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAbuseReportdefaultResponse
{
"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'."
}
ListsGetAllAbuseReports200Response
{
"type": "object",
"title": "Abuse Complaints",
"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 for the abuse report."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAllAbuseReportsResponse
{
"type": "object",
"title": "Abuse Complaints",
"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 for the abuse report."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAllAbuseReportsdefaultResponse
{
"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'."
}
ListsGetAllInfo200Response
{
"type": "object",
"title": "Subscriber Lists",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"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."
},
"title": "Lists",
"description": "An array of objects, each representing a list."
},
"_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."
},
"constraints": {
"type": "object",
"title": "Collection Authorization",
"required": [
"may_create",
"max_instances"
],
"properties": {
"may_create": {
"type": "boolean",
"title": "Resource creation authorization",
"description": "May the user create additional instances of this resource?"
},
"max_instances": {
"type": "integer",
"title": "Max instances",
"description": "How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited."
},
"current_total_instances": {
"type": "integer",
"title": "Current total instances",
"description": "How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited."
}
},
"description": "Do particular authorization constraints around this collection limit creation of new instances?"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization."
}
ListsGetAllInfoResponse
{
"type": "object",
"title": "Subscriber Lists",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"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."
},
"title": "Lists",
"description": "An array of objects, each representing a list."
},
"_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."
},
"constraints": {
"type": "object",
"title": "Collection Authorization",
"required": [
"may_create",
"max_instances"
],
"properties": {
"may_create": {
"type": "boolean",
"title": "Resource creation authorization",
"description": "May the user create additional instances of this resource?"
},
"max_instances": {
"type": "integer",
"title": "Max instances",
"description": "How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited."
},
"current_total_instances": {
"type": "integer",
"title": "Current total instances",
"description": "How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited."
}
},
"description": "Do particular authorization constraints around this collection limit creation of new instances?"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization."
}
ListsGetAllInfodefaultResponse
{
"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'."
}
ListsGetGrowthHistoryByMonth200Response
{
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
}
ListsGetGrowthHistoryByMonthResponse
{
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
}
ListsGetGrowthHistoryByMonthdefaultResponse
{
"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'."
}
ListsGetGrowthHistoryData200Response
{
"type": "object",
"title": "Growth History",
"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."
},
"history": {
"type": "array",
"items": {
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
},
"title": "Members",
"description": "An array of objects, each representing a monthly growth report for a list."
},
"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": "A month-by-month summary of a specific list's growth activity."
}
ListsGetGrowthHistoryDataResponse
{
"type": "object",
"title": "Growth History",
"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."
},
"history": {
"type": "array",
"items": {
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
},
"title": "Members",
"description": "An array of objects, each representing a monthly growth report for a list."
},
"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": "A month-by-month summary of a specific list's growth activity."
}
ListsGetGrowthHistoryDatadefaultResponse
{
"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'."
}
ListsGetInterestCategoryInfo200Response
{
"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."
}
ListsGetInterestCategoryInfoResponse
{
"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."
}
ListsGetInterestCategoryInfodefaultResponse
{
"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'."
}
ListsGetInterestInCategory200Response
{
"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."
}
ListsGetInterestInCategoryResponse
{
"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."
}
ListsGetInterestInCategorydefaultResponse
{
"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'."
}