Lists

A MailChimp list is a powerful and flexible tool that helps you manage your contacts. Learn how to get started with lists in MailChimp.

Subresources

Available methods

    • POST /lists Create a new list
      POST /lists/{list_id} Batch sub/unsub list members

      Create a new list

      POST /lists

      Create a new list in your MailChimp account.

      Request body parameters

      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv

      Response body parameters

      id Type: String Title: List ID Read only: true A string that uniquely identifies this list.
      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      date_created Type: String Title: Creation Date Read only: true The date and time that this list was created.
      list_rating Type: Integer Title: List Rating Read only: true An auto-generated activity score for the list (0-5).
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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_short Type: String Title: Subscribe URL Short Read only: true Our EepURL shortened version of this list’s subscribe form.
      subscribe_url_long Type: String Title: Subscribe URL Long Read only: true The full version of this list’s subscribe form (host will vary).
      beamer_address Type: String Title: Beamer Address Read only: true The list’s Email Beamer address.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv
      modules Type: Array Title: Modules Read only: true Any list-specific modules installed for this list.
      stats Type: Object Title: Statistics Read only: true Stats for the list. Many of these are cached for at least five minutes.
      Show properties
      member_count Type: Integer Title: Member Count Read only: true The number of active members in the list.
      unsubscribe_count Type: Integer Title: Unsubscribe Count Read only: true The number of members who have unsubscribed from the list.
      cleaned_count Type: Integer Title: Cleaned Count Read only: true The number of members cleaned from the list.
      member_count_since_send Type: Integer Title: Member Count Since Send Read only: true The number of active members in the list since the last campaign was sent.
      unsubscribe_count_since_send Type: Integer Title: Unsubscribe Count Since Send Read only: true The number of members who have unsubscribed since the last campaign was sent.
      cleaned_count_since_send Type: Integer Title: Cleaned Count Since Send Read only: true The number of members cleaned from the list since the last campaign was sent.
      campaign_count Type: Integer Title: Campaign Count Read only: true The number of campaigns in any status that use this list.
      campaign_last_sent Type: String Title: Campaign Last Sent Read only: true The date and time the last campaign was sent to this list.
      merge_field_count Type: Integer Title: Merge Var Count Read only: true The number of merge vars for this list (not EMAIL, which is required).
      avg_sub_rate Type: Number Title: Average Subscription Rate Read only: true The average number of subscriptions per month for the list (not returned if we haven’t calculated it yet).
      avg_unsub_rate Type: Number Title: Average Unsubscription Rate Read only: true The average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet).
      target_sub_rate Type: Number Title: Average Subscription Rate Read only: true The target number of subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet).
      open_rate Type: Number Title: Open Rate Read only: true 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 Read only: true 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).
      last_sub_date Type: String Title: Date of Last List Subscribe Read only: true The date and time of the last time someone subscribed to this list.
      last_unsub_date Type: String Title: Date of Last List Unsubscribe Read only: true The date and time of the last time someone unsubscribed from this list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
curl --request POST \
--url 'https://usX.api.mailchimp.com/3.0/lists' \
--user 'anystring:apikey' \
--header 'content-type: application/json' \
--data '{"name":"Freddie'\''s Favorite Hats","contact":{"company":"MailChimp","address1":"675 Ponce De Leon Ave NE","address2":"Suite 5000","city":"Atlanta","state":"GA","zip":"30308","country":"US","phone":""},"permission_reminder":"You'\''re receiving this email because you signed up for updates about Freddie'\''s newest hats.","campaign_defaults":{"from_name":"Freddie","from_email":"[email protected]","subject":"","language":"en"},"email_type_option":true}' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 3931
Vary: Accept-Encoding
X-Request-Id: 1a4d7589-52c1-4571-b486-ddc9c591edfb
Link: <https://api.mailchimp.com/schema/3.0/Lists/Instance.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 14:55:52 GMT
Connection: keep-alive


{
  "id": "1510500e0b",
  "name": "Freddie's Favorite Hats",
  "contact": {
    "company": "MailChimp",
    "address1": "675 Ponce De Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30308",
    "country": "US",
    "phone": ""
  },
  "permission_reminder": "",
  "use_archive_bar": true,
  "campaign_defaults": {
    "from_name": "Freddie",
    "from_email": "[email protected]",
    "subject": "",
    "language": "en"
  },
  "notify_on_subscribe": "",
  "notify_on_unsubscribe": "",
  "date_created": "2015-09-16T14:55:51+00:00",
  "list_rating": 0,
  "email_type_option": true,
  "subscribe_url_short": "http://eepurl.com/xxxx",
  "subscribe_url_long": "http://freddieshats.usX.list-manage.com/subscribe?u=8d3a3db4d97663a9074efcc16&id=1510500e0b",
  "beamer_address": "[email protected]",
  "visibility": "pub",
  "modules": [],
  "stats": {
    "member_count": 0,
    "unsubscribe_count": 0,
    "cleaned_count": 0,
    "member_count_since_send": 0,
    "unsubscribe_count_since_send": 0,
    "cleaned_count_since_send": 0,
    "campaign_count": 0,
    "campaign_last_sent": "",
    "merge_field_count": 2,
    "avg_sub_rate": 0,
    "avg_unsub_rate": 0,
    "target_sub_rate": 0,
    "open_rate": 0,
    "click_rate": 0,
    "last_sub_date": "",
    "last_unsub_date": ""
  },
  "_links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/lists",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
    },
    {
      "rel": "update",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b",
      "method": "PATCH",
      "schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "delete",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b",
      "method": "DELETE"
    },
    {
      "rel": "abuse-reports",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/abuse-reports",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
    },
    {
      "rel": "activity",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/activity",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Activity/Collection.json"
    },
    {
      "rel": "clients",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/clients",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Clients/Collection.json"
    },
    {
      "rel": "growth-history",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/growth-history",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
    },
    {
      "rel": "interest-categories",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/interest-categories",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/InterestCategories.json"
    },
    {
      "rel": "members",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/members",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
    },
    {
      "rel": "merge-fields",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/merge-fields",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/MergeFields/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/MergeFields.json"
    },
    {
      "rel": "segments",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/segments",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
    }
  ]
}

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Batch sub/unsub list members

      POST /lists/{list_id}

      Batch subscribe or unsubscribe list members.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      members Type: Array Title: List Members Read only: false 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.
      Show properties
      email_address Type: String Title: Email Address Read only: false Email address for a subscriber.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      ip_signup Type: String Title: Signup IP Read only: false IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: false The date and time the subscriber signed up for the list.
      ip_opt Type: String Title: Opt-in IP Read only: false The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: false The date and time the subscribe confirmed their opt-in status.
      update_existing Type: Boolean Title: Update Existing Members Read only: false Whether this batch operation will change existing members’ subscription status.

      Response body parameters

      new_members Type: Array Title: New members Read only: false An array of objects, each representing a new member that was added to the list.
      Show properties
      id Type: String Title: Email ID Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: true Email address for a subscriber.
      unique_email_id Type: String Title: Unique Email ID Read only: true An identifier for the address across all of MailChimp.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      stats Type: Object Title: Subscriber Stats Read only: true Open and click rates for this subscriber.
      Show properties
      avg_open_rate Type: Number Title: Average Open Rate Read only: true A subscriber’s average open rate.
      avg_click_rate Type: Number Title: Average Click Rate Read only: true A subscriber’s average clickthrough rate.
      ip_signup Type: String Title: Signup IP Read only: true IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: true The date and time the subscriber signed up for the list.
      ip_opt Type: String Title: Opt-in IP Read only: true The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: true The date and time the subscribe confirmed their opt-in status.
      member_rating Type: Integer Title: Member Rating Read only: true Star rating for this member, between 1 and 5.
      last_changed Type: String Title: Last Changed Date Read only: true The date and time the member’s info was last changed.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      email_client Type: String Title: Email Client Read only: true The list member’s email client.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      gmtoff Type: Integer Title: GMT Offset Read only: true The time difference in hours from GMT.
      dstoff Type: Integer Title: DST Offset Read only: true The offset for timezones where daylight saving time is observed.
      country_code Type: String Title: Country Code Read only: true The unique code for the location country.
      timezone Type: String Title: Timezone Read only: true The timezone for the location.
      last_note Type: Object Title: Notes Read only: true The most recent Note added about this member.
      Show properties
      note_id Type: Integer Title: Note ID Read only: true The note id.
      created_at Type: String Title: Created Time Read only: true The date and time the note was created.
      created_by Type: String Title: Author Read only: true The author of the note.
      note Type: String Title: Note Read only: true The content of the note.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      updated_members Type: Array Title: Updated Members Read only: false An array of objects, each representing an existing list member whose subscription status was updated.
      Show properties
      id Type: String Title: Email ID Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: true Email address for a subscriber.
      unique_email_id Type: String Title: Unique Email ID Read only: true An identifier for the address across all of MailChimp.
      email_type Type: String Title: Email Type Read only: false Type of email this member asked to get (‘html’ or ‘text’).
      status Type: String Title: Status Read only: false Subscriber’s current status.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      merge_fields Type: Object Title: Member Merge Var Read only: false An individual merge var and value for a member.
      interests Type: Object Title: Subscriber Interests Read only: false The key of this object’s properties is the ID of the interest in question.
      stats Type: Object Title: Subscriber Stats Read only: true Open and click rates for this subscriber.
      Show properties
      avg_open_rate Type: Number Title: Average Open Rate Read only: true A subscriber’s average open rate.
      avg_click_rate Type: Number Title: Average Click Rate Read only: true A subscriber’s average clickthrough rate.
      ip_signup Type: String Title: Signup IP Read only: true IP address the subscriber signed up from.
      timestamp_signup Type: String Title: Signup Timestamp Read only: true The date and time the subscriber signed up for the list.
      ip_opt Type: String Title: Opt-in IP Read only: true The IP address the subscriber used to confirm their opt-in status.
      timestamp_opt Type: String Title: Opt-in Timestamp Read only: true The date and time the subscribe confirmed their opt-in status.
      member_rating Type: Integer Title: Member Rating Read only: true Star rating for this member, between 1 and 5.
      last_changed Type: String Title: Last Changed Date Read only: true The date and time the member’s info was last changed.
      language Type: String Title: Language Read only: false If set/detected, the subscriber’s language.
      vip Type: Boolean Title: VIP Read only: false VIP status for subscriber.
      email_client Type: String Title: Email Client Read only: true The list member’s email client.
      location Type: Object Title: Location Read only: false Subscriber location information.
      Show properties
      latitude Type: Number Title: Latitude Read only: false The location latitude.
      longitude Type: Number Title: Longitude Read only: false The location longitude.
      gmtoff Type: Integer Title: GMT Offset Read only: true The time difference in hours from GMT.
      dstoff Type: Integer Title: DST Offset Read only: true The offset for timezones where daylight saving time is observed.
      country_code Type: String Title: Country Code Read only: true The unique code for the location country.
      timezone Type: String Title: Timezone Read only: true The timezone for the location.
      last_note Type: Object Title: Notes Read only: true The most recent Note added about this member.
      Show properties
      note_id Type: Integer Title: Note ID Read only: true The note id.
      created_at Type: String Title: Created Time Read only: true The date and time the note was created.
      created_by Type: String Title: Author Read only: true The author of the note.
      note Type: String Title: Note Read only: true The content of the note.
      list_id Type: String Title: List ID Read only: true The list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      errors Type: Array Title: Errors Read only: false 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.
      Show properties
      email_address Type: String Title: Member Email address Read only: false The email address that could not be added or updated.
      error Type: String Title: Error message Read only: false The error message indicating why the email address could not be added or updated.
      total_created Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      total_updated Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      error_count Type: Integer Title: Item Count Read only: false The total number of items matching the query, irrespective of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
curl --request POST \
--url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4' \
--user 'anystring:apikey' \
--header 'content-type: application/json' \
--data '{"members": [{"email_address": "[email protected]", "status": "subscribed"}, {"email_address": "urist.mcvankab+[email protected]", "status": "subscribed"}, {"email_address": "urist.mcvankab+[email protected]", "status_if_new": "subscribed"}], "update_existing": true}' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 30 Aug 2016 14:43:13 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 7567
Connection: keep-alive
Vary: Accept-Encoding
X-Request-Id: 5cdd8812-fe73-47da-bc84-be3f067ba249
Link: <https://api.mailchimp.com/schema/3.0/Lists/Instance.json>; rel="describedBy", <https://admin.mailchimp.com/lists/members/?id=814689>; rel="dashboard"

{
  "new_members": [
    {
      "id": "62eeb292278cc15f5817cb78f7790b08",
      "email_address": "[email protected]",
      "unique_email_id": "88310588a3",
      "email_type": "html",
      "status": "subscribed",
      "merge_fields": {
        "FNAME": "",
        "LNAME": "",
        "MMERGE3": "",
        "MMERGE4": ""
      },
      "interests": {
        "b6eedaaa61": false,
        "3a7e863e3d": false,
        "c8d1ed2930": false,
        "973e028130": false,
        "cf07cbb719": false
      },
      "stats": {
        "avg_open_rate": 0,
        "avg_click_rate": 0
      },
      "ip_signup": "",
      "timestamp_signup": "",
      "ip_opt": "199.33.145.48",
      "timestamp_opt": "2016-08-30T14:43:13+00:00",
      "member_rating": 2,
      "last_changed": "2016-08-30T14:43:13+00:00",
      "language": "",
      "vip": false,
      "email_client": "",
      "location": {
        "latitude": 0,
        "longitude": 0,
        "gmtoff": 0,
        "dstoff": 0,
        "country_code": "",
        "timezone": ""
      },
      "list_id": "205d96e6b4",
      "_links": [
        {
          "rel": "self",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "parent",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
        },
        {
          "rel": "update",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08",
          "method": "PATCH",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "upsert",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08",
          "method": "PUT",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "delete",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08",
          "method": "DELETE"
        },
        {
          "rel": "activity",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08/activity",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
        },
        {
          "rel": "goals",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08/goals",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
        },
        {
          "rel": "notes",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/62eeb292278cc15f5817cb78f7790b08/notes",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
        }
      ]
    },
    {
      "id": "f777bbffab8d1ceca8b757df63c47cb8",
      "email_address": "urist.mcvankab+[email protected]",
      "unique_email_id": "dac0d532c4",
      "email_type": "html",
      "status": "subscribed",
      "merge_fields": {
        "FNAME": "",
        "LNAME": "",
        "MMERGE3": "",
        "MMERGE4": ""
      },
      "interests": {
        "b6eedaaa61": false,
        "3a7e863e3d": false,
        "c8d1ed2930": false,
        "973e028130": false,
        "cf07cbb719": false
      },
      "stats": {
        "avg_open_rate": 0,
        "avg_click_rate": 0
      },
      "ip_signup": "",
      "timestamp_signup": "",
      "ip_opt": "199.33.145.48",
      "timestamp_opt": "2016-08-30T14:43:13+00:00",
      "member_rating": 2,
      "last_changed": "2016-08-30T14:43:13+00:00",
      "language": "",
      "vip": false,
      "email_client": "",
      "location": {
        "latitude": 0,
        "longitude": 0,
        "gmtoff": 0,
        "dstoff": 0,
        "country_code": "",
        "timezone": ""
      },
      "list_id": "205d96e6b4",
      "_links": [
        {
          "rel": "self",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "parent",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
        },
        {
          "rel": "update",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8",
          "method": "PATCH",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "upsert",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8",
          "method": "PUT",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "delete",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8",
          "method": "DELETE"
        },
        {
          "rel": "activity",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8/activity",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
        },
        {
          "rel": "goals",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8/goals",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
        },
        {
          "rel": "notes",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/f777bbffab8d1ceca8b757df63c47cb8/notes",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
        }
      ]
    },
    {
      "id": "796b7017ce40a94ba27df7a19ff95811",
      "email_address": "urist.mcvankab+[email protected]",
      "unique_email_id": "da2392af17",
      "email_type": "html",
      "status": "subscribed",
      "merge_fields": {
        "FNAME": "",
        "LNAME": "",
        "MMERGE3": "",
        "MMERGE4": ""
      },
      "interests": {
        "b6eedaaa61": false,
        "3a7e863e3d": false,
        "c8d1ed2930": false,
        "973e028130": false,
        "cf07cbb719": false
      },
      "stats": {
        "avg_open_rate": 0,
        "avg_click_rate": 0
      },
      "ip_signup": "",
      "timestamp_signup": "",
      "ip_opt": "199.33.145.48",
      "timestamp_opt": "2016-08-30T14:43:13+00:00",
      "member_rating": 2,
      "last_changed": "2016-08-30T14:43:13+00:00",
      "language": "",
      "vip": false,
      "email_client": "",
      "location": {
        "latitude": 0,
        "longitude": 0,
        "gmtoff": 0,
        "dstoff": 0,
        "country_code": "",
        "timezone": ""
      },
      "list_id": "205d96e6b4",
      "_links": [
        {
          "rel": "self",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "parent",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
        },
        {
          "rel": "update",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811",
          "method": "PATCH",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "upsert",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811",
          "method": "PUT",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
        },
        {
          "rel": "delete",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811",
          "method": "DELETE"
        },
        {
          "rel": "activity",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811/activity",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Activity/Collection.json"
        },
        {
          "rel": "goals",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811/goals",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
        },
        {
          "rel": "notes",
          "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/members/796b7017ce40a94ba27df7a19ff95811/notes",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
        }
      ]
    }
  ],
  "updated_members": [],
  "errors": [],
  "total_created": 3,
  "total_updated": 0,
  "error_count": 0
}

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /lists Get information about all lists
      GET /lists/{list_id} Get information about a specific list

      Get information about all lists

      GET /lists

      Get information about all lists in the account.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.
      before_date_created Type: String Title: Before Date Created Read only: false Restrict response to lists created before the set date.
      since_date_created Type: String Title: Since Date Created Read only: false Restrict results to lists created after the set date.
      before_campaign_last_sent Type: String Title: Before Campaign Last Sent Read only: false Restrict results to lists created before the last campaign send date.
      since_campaign_last_sent Type: String Title: Since Campaign Last Sent Read only: false Restrict results to lists created after the last campaign send date.
      email Type: String Title: Subscriber Email Read only: false Restrict results to lists that include a specific subscriber’s email address.

      Response body parameters

      lists Type: Array Title: Lists Read only: false An array of objects, each representing a list.
      Show properties
      id Type: String Title: List ID Read only: true A string that uniquely identifies this list.
      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      date_created Type: String Title: Creation Date Read only: true The date and time that this list was created.
      list_rating Type: Integer Title: List Rating Read only: true An auto-generated activity score for the list (0-5).
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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_short Type: String Title: Subscribe URL Short Read only: true Our EepURL shortened version of this list’s subscribe form.
      subscribe_url_long Type: String Title: Subscribe URL Long Read only: true The full version of this list’s subscribe form (host will vary).
      beamer_address Type: String Title: Beamer Address Read only: true The list’s Email Beamer address.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv
      modules Type: Array Title: Modules Read only: true Any list-specific modules installed for this list.
      stats Type: Object Title: Statistics Read only: true Stats for the list. Many of these are cached for at least five minutes.
      Show properties
      member_count Type: Integer Title: Member Count Read only: true The number of active members in the list.
      unsubscribe_count Type: Integer Title: Unsubscribe Count Read only: true The number of members who have unsubscribed from the list.
      cleaned_count Type: Integer Title: Cleaned Count Read only: true The number of members cleaned from the list.
      member_count_since_send Type: Integer Title: Member Count Since Send Read only: true The number of active members in the list since the last campaign was sent.
      unsubscribe_count_since_send Type: Integer Title: Unsubscribe Count Since Send Read only: true The number of members who have unsubscribed since the last campaign was sent.
      cleaned_count_since_send Type: Integer Title: Cleaned Count Since Send Read only: true The number of members cleaned from the list since the last campaign was sent.
      campaign_count Type: Integer Title: Campaign Count Read only: true The number of campaigns in any status that use this list.
      campaign_last_sent Type: String Title: Campaign Last Sent Read only: true The date and time the last campaign was sent to this list.
      merge_field_count Type: Integer Title: Merge Var Count Read only: true The number of merge vars for this list (not EMAIL, which is required).
      avg_sub_rate Type: Number Title: Average Subscription Rate Read only: true The average number of subscriptions per month for the list (not returned if we haven’t calculated it yet).
      avg_unsub_rate Type: Number Title: Average Unsubscription Rate Read only: true The average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet).
      target_sub_rate Type: Number Title: Average Subscription Rate Read only: true The target number of subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet).
      open_rate Type: Number Title: Open Rate Read only: true 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 Read only: true 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).
      last_sub_date Type: String Title: Date of Last List Subscribe Read only: true The date and time of the last time someone subscribed to this list.
      last_unsub_date Type: String Title: Date of Last List Unsubscribe Read only: true The date and time of the last time someone unsubscribed from this list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
curl --request GET \
--url 'https://usX.api.mailchimp.com/3.0/lists' \
--user 'anystring:apikey' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Vary: Accept-Encoding
X-Request-Id: a4c491b5-2bd2-46b2-8b3f-e33e8c8bef04
Link: <https://api.mailchimp.com/schema/3.0/Lists/Collection.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 14:42:17 GMT
Content-Length: 17012
Connection: keep-alive


{
  "lists": [
    {
      "id": "57afe96172",
      "name": "Freddie's Jokes",
      "contact": {
        "company": "MailChimp",
        "address1": "675 Ponce De Leon Ave NE",
        "address2": "Suite 5000",
        "city": "Atlanta",
        "state": "GA",
        "zip": "30308",
        "country": "US",
        "phone": ""
      },
      "permission_reminder": "You're receiving this email because you just can't get enough of Freddie's jokes.",
      "use_archive_bar": false,
      "campaign_defaults": {
        "from_name": "Freddie",
        "from_email": "[email protected]",
        "subject": "",
        "language": "en"
      },
      "notify_on_subscribe": "",
      "notify_on_unsubscribe": "",
      "date_created": "2015-09-15T14:38:16+00:00",
      "list_rating": 3,
      "email_type_option": false,
      "subscribe_url_short": "http://eepurl.com/xxxx",
      "subscribe_url_long": "http://freddiesjokes.usX.list-manage.com/subscribe?u=8d3a3db4d97663a9074efcc16&id=xxxx",
      "beamer_address": "[email protected]",
      "visibility": "prv",
      "modules": [],
      "stats": {
        "member_count": 203,
        "unsubscribe_count": 0,
        "cleaned_count": 0,
        "member_count_since_send": 0,
        "unsubscribe_count_since_send": 0,
        "cleaned_count_since_send": 0,
        "campaign_count": 3,
        "campaign_last_sent": "",
        "merge_field_count": 2,
        "avg_sub_rate": 15,
        "avg_unsub_rate": 0,
        "target_sub_rate": 0,
        "open_rate": 0,
        "click_rate": 0,
        "last_sub_date": "2015-09-15T17:27:16+00:00",
        "last_unsub_date": ""
      },
      "_links": [
        {
          "rel": "self",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
        },
        {
          "rel": "parent",
          "href": "https://usX.api.mailchimp.com/3.0/lists",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
        },
        {
          "rel": "update",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
          "method": "PATCH",
          "schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
        },
        {
          "rel": "delete",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
          "method": "DELETE"
        },
        {
          "rel": "abuse-reports",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/abuse-reports",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
        },
        {
          "rel": "activity",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/activity",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Activity/Collection.json"
        },
        {
          "rel": "clients",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/clients",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Clients/Collection.json"
        },
        {
          "rel": "growth-history",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
        },
        {
          "rel": "interest-categories",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/InterestCategories.json"
        },
        {
          "rel": "members",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
        },
        {
          "rel": "merge-fields",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/merge-fields",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/MergeFields/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/MergeFields.json"
        },
        {
          "rel": "segments",
          "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
          "method": "GET",
          "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
          "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
    },
    {
      "rel": "create",
      "href": "https://usX.api.mailchimp.com/3.0/lists",
      "method": "POST",
      "schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    }
  ],
  "total_items": 1
}

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific list

      GET /lists/{list_id}

      Get information about a specific list in your MailChimp account. Results include list members who have signed up but haven’t confirmed their subscription yet and unsubscribed or cleaned.

      Path parameters

      list_id The unique id for the list.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: List ID Read only: true A string that uniquely identifies this list.
      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      date_created Type: String Title: Creation Date Read only: true The date and time that this list was created.
      list_rating Type: Integer Title: List Rating Read only: true An auto-generated activity score for the list (0-5).
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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_short Type: String Title: Subscribe URL Short Read only: true Our EepURL shortened version of this list’s subscribe form.
      subscribe_url_long Type: String Title: Subscribe URL Long Read only: true The full version of this list’s subscribe form (host will vary).
      beamer_address Type: String Title: Beamer Address Read only: true The list’s Email Beamer address.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv
      modules Type: Array Title: Modules Read only: true Any list-specific modules installed for this list.
      stats Type: Object Title: Statistics Read only: true Stats for the list. Many of these are cached for at least five minutes.
      Show properties
      member_count Type: Integer Title: Member Count Read only: true The number of active members in the list.
      unsubscribe_count Type: Integer Title: Unsubscribe Count Read only: true The number of members who have unsubscribed from the list.
      cleaned_count Type: Integer Title: Cleaned Count Read only: true The number of members cleaned from the list.
      member_count_since_send Type: Integer Title: Member Count Since Send Read only: true The number of active members in the list since the last campaign was sent.
      unsubscribe_count_since_send Type: Integer Title: Unsubscribe Count Since Send Read only: true The number of members who have unsubscribed since the last campaign was sent.
      cleaned_count_since_send Type: Integer Title: Cleaned Count Since Send Read only: true The number of members cleaned from the list since the last campaign was sent.
      campaign_count Type: Integer Title: Campaign Count Read only: true The number of campaigns in any status that use this list.
      campaign_last_sent Type: String Title: Campaign Last Sent Read only: true The date and time the last campaign was sent to this list.
      merge_field_count Type: Integer Title: Merge Var Count Read only: true The number of merge vars for this list (not EMAIL, which is required).
      avg_sub_rate Type: Number Title: Average Subscription Rate Read only: true The average number of subscriptions per month for the list (not returned if we haven’t calculated it yet).
      avg_unsub_rate Type: Number Title: Average Unsubscription Rate Read only: true The average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet).
      target_sub_rate Type: Number Title: Average Subscription Rate Read only: true The target number of subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet).
      open_rate Type: Number Title: Open Rate Read only: true 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 Read only: true 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).
      last_sub_date Type: String Title: Date of Last List Subscribe Read only: true The date and time of the last time someone subscribed to this list.
      last_unsub_date Type: String Title: Date of Last List Unsubscribe Read only: true The date and time of the last time someone unsubscribed from this list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
curl --request GET \
--url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172' \
--user 'anystring:apikey' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 3954
Vary: Accept-Encoding
X-Request-Id: cdeae63b-3a42-4e39-821a-c92292633eaa
Link: <https://api.mailchimp.com/schema/3.0/Lists/Instance.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 15:27:09 GMT
Connection: keep-alive


{
  "id": "57afe96172",
  "name": "Freddie's Jokes",
  "contact": {
    "company": "MailChimp",
    "address1": "675 Ponce De Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30308",
    "country": "US",
    "phone": ""
  },
  "permission_reminder": "",
  "use_archive_bar": false,
  "campaign_defaults": {
    "from_name": "Freddie",
    "from_email": "[email protected]",
    "subject": "",
    "language": "en"
  },
  "notify_on_subscribe": "",
  "notify_on_unsubscribe": "",
  "date_created": "2015-09-15T14:38:16+00:00",
  "list_rating": 3,
  "email_type_option": false,
  "subscribe_url_short": "http://eepurl.com/xxxx",
  "subscribe_url_long": "http://freddiesjokes.usX.list-manage1.com/subscribe?u=8d3a3db4d97663a9074efcc16&id=57afe96172",
  "beamer_address": "[email protected]",
  "visibility": "prv",
  "modules": [],
  "stats": {
    "member_count": 203,
    "unsubscribe_count": 0,
    "cleaned_count": 0,
    "member_count_since_send": 0,
    "unsubscribe_count_since_send": 0,
    "cleaned_count_since_send": 0,
    "campaign_count": 3,
    "campaign_last_sent": "",
    "merge_field_count": 2,
    "avg_sub_rate": 15,
    "avg_unsub_rate": 0,
    "target_sub_rate": 0,
    "open_rate": 0,
    "click_rate": 0,
    "last_sub_date": "2015-09-15T17:27:16+00:00",
    "last_unsub_date": ""
  },
  "_links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/lists",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
    },
    {
      "rel": "update",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "PATCH",
      "schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "delete",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "DELETE"
    },
    {
      "rel": "abuse-reports",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/abuse-reports",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
    },
    {
      "rel": "activity",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/activity",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Activity/Collection.json"
    },
    {
      "rel": "clients",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/clients",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Clients/Collection.json"
    },
    {
      "rel": "growth-history",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
    },
    {
      "rel": "interest-categories",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/InterestCategories.json"
    },
    {
      "rel": "members",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
    },
    {
      "rel": "merge-fields",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/merge-fields",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/MergeFields/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/MergeFields.json"
    },
    {
      "rel": "segments",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
    }
  ]
}

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • PATCH /lists/{list_id} Update a specific list

      Update a specific list

      PATCH /lists/{list_id}

      Update the settings for a specific list.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv

      Response body parameters

      id Type: String Title: List ID Read only: true A string that uniquely identifies this list.
      name Type: String Title: List Name Read only: false The name of the list.
      contact Type: Object Title: List Contact Read only: false Contact information displayed in campaign footers to comply with international spam laws.
      Show properties
      company Type: String Title: Company Name Read only: false The company name for the list.
      address1 Type: String Title: Address Read only: false The street address for the list contact.
      address2 Type: String Title: Address Read only: false The street address for the list contact.
      city Type: String Title: City Read only: false The city for the list contact.
      state Type: String Title: State Read only: false The state for the list contact.
      zip Type: String Title: Postal Code Read only: false The postal or zip code for the list contact.
      country Type: String Title: Country Code Read only: false A two-character ISO3166 country code. Defaults to US if invalid.
      phone Type: String Title: Phone Number Read only: false The phone number for the list contact.
      permission_reminder Type: String Title: Permission Reminder Read only: false The permission reminder for the list.
      use_archive_bar Type: Boolean Title: Use Archive Bar Read only: false Whether campaigns for this list use the Archive Bar in archives by default.
      campaign_defaults Type: Object Title: Campaign Defaults Read only: false Default values for campaigns created for this list.
      Show properties
      from_name Type: String Title: Sender's Name Read only: false The default from name for campaigns sent to this list.
      from_email Type: String Title: Sender's Email Address Read only: false The default from email for campaigns sent to this list.
      subject Type: String Title: Subject Read only: false The default subject line for campaigns sent to this list.
      language Type: String Title: Language Read only: false The default language for this lists’s forms.
      notify_on_subscribe Type: String Title: Notify on Subscribe Read only: false The email address to send subscribe notifications to.
      notify_on_unsubscribe Type: String Title: Notify on Unsubscribe Read only: false The email address to send unsubscribe notifications to.
      date_created Type: String Title: Creation Date Read only: true The date and time that this list was created.
      list_rating Type: Integer Title: List Rating Read only: true An auto-generated activity score for the list (0-5).
      email_type_option Type: Boolean Title: Email Type Option Read only: false Whether the list supports multiple formats for emails. 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_short Type: String Title: Subscribe URL Short Read only: true Our EepURL shortened version of this list’s subscribe form.
      subscribe_url_long Type: String Title: Subscribe URL Long Read only: true The full version of this list’s subscribe form (host will vary).
      beamer_address Type: String Title: Beamer Address Read only: true The list’s Email Beamer address.
      visibility Type: String Title: Visibility Read only: false Whether this list is public or private.
      Possible Values:
      • pub
      • prv
      modules Type: Array Title: Modules Read only: true Any list-specific modules installed for this list.
      stats Type: Object Title: Statistics Read only: true Stats for the list. Many of these are cached for at least five minutes.
      Show properties
      member_count Type: Integer Title: Member Count Read only: true The number of active members in the list.
      unsubscribe_count Type: Integer Title: Unsubscribe Count Read only: true The number of members who have unsubscribed from the list.
      cleaned_count Type: Integer Title: Cleaned Count Read only: true The number of members cleaned from the list.
      member_count_since_send Type: Integer Title: Member Count Since Send Read only: true The number of active members in the list since the last campaign was sent.
      unsubscribe_count_since_send Type: Integer Title: Unsubscribe Count Since Send Read only: true The number of members who have unsubscribed since the last campaign was sent.
      cleaned_count_since_send Type: Integer Title: Cleaned Count Since Send Read only: true The number of members cleaned from the list since the last campaign was sent.
      campaign_count Type: Integer Title: Campaign Count Read only: true The number of campaigns in any status that use this list.
      campaign_last_sent Type: String Title: Campaign Last Sent Read only: true The date and time the last campaign was sent to this list.
      merge_field_count Type: Integer Title: Merge Var Count Read only: true The number of merge vars for this list (not EMAIL, which is required).
      avg_sub_rate Type: Number Title: Average Subscription Rate Read only: true The average number of subscriptions per month for the list (not returned if we haven’t calculated it yet).
      avg_unsub_rate Type: Number Title: Average Unsubscription Rate Read only: true The average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet).
      target_sub_rate Type: Number Title: Average Subscription Rate Read only: true The target number of subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet).
      open_rate Type: Number Title: Open Rate Read only: true 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 Read only: true 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).
      last_sub_date Type: String Title: Date of Last List Subscribe Read only: true The date and time of the last time someone subscribed to this list.
      last_unsub_date Type: String Title: Date of Last List Unsubscribe Read only: true The date and time of the last time someone unsubscribed from this list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
curl --request PATCH \
--url 'https://usX.api.mailchimp.com/3.0/file-manager/folders/861' \
--user 'anystring:apikey' \
--header 'content-type: application/json' \
--data '{"name":"Freddie'\''s Favorite Bags","contact":{"company":"MailChimp","address1":"675 Ponce De Leon Ave NE","address2":"Suite 5000","city":"Atlanta","state":"GA","zip":"30308","country":"US","phone":""},"permission_reminder":"You'\''re receiving this email because you signed up for updates about Freddie'\''s newest bags.","campaign_defaults":{"from_name":"Freddie","from_email":"[email protected]","subject":"","language":"en"},"email_type_option":true}' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 3959
Vary: Accept-Encoding
X-Request-Id: 7a49744c-00b8-44ce-a4c2-71b202bd4118
Link: <https://api.mailchimp.com/schema/3.0/Lists/Instance.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 15:30:15 GMT
Connection: keep-alive


{
  "id": "57afe96172",
  "name": "Freddie's Favorite Bags",
  "contact": {
    "company": "MailChimp",
    "address1": "675 Ponce De Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30308",
    "country": "US",
    "phone": ""
  },
  "permission_reminder": "",
  "use_archive_bar": false,
  "campaign_defaults": {
    "from_name": "Freddie",
    "from_email": "[email protected]",
    "subject": "",
    "language": "en"
  },
  "notify_on_subscribe": "",
  "notify_on_unsubscribe": "",
  "date_created": "2015-09-15T14:38:16+00:00",
  "list_rating": 3,
  "email_type_option": true,
  "subscribe_url_short": "http://eepurl.com/xxxx",
  "subscribe_url_long": "http://freddiesbags.usX.list-manage.com/subscribe?u=8d3a3db4d97663a9074efcc16&id=57afe96172",
  "beamer_address": "[email protected]",
  "visibility": "prv",
  "modules": [],
  "stats": {
    "member_count": 203,
    "unsubscribe_count": 0,
    "cleaned_count": 0,
    "member_count_since_send": 0,
    "unsubscribe_count_since_send": 0,
    "cleaned_count_since_send": 0,
    "campaign_count": 3,
    "campaign_last_sent": "",
    "merge_field_count": 2,
    "avg_sub_rate": 15,
    "avg_unsub_rate": 0,
    "target_sub_rate": 0,
    "open_rate": 0,
    "click_rate": 0,
    "last_sub_date": "2015-09-15T17:27:16+00:00",
    "last_unsub_date": ""
  },
  "_links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/lists",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
    },
    {
      "rel": "update",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "PATCH",
      "schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
    },
    {
      "rel": "delete",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
      "method": "DELETE"
    },
    {
      "rel": "abuse-reports",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/abuse-reports",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
    },
    {
      "rel": "activity",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/activity",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Activity/Collection.json"
    },
    {
      "rel": "clients",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/clients",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Clients/Collection.json"
    },
    {
      "rel": "growth-history",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
    },
    {
      "rel": "interest-categories",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/InterestCategories.json"
    },
    {
      "rel": "members",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
    },
    {
      "rel": "merge-fields",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/merge-fields",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/MergeFields/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/MergeFields.json"
    },
    {
      "rel": "segments",
      "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/segments",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
    }
  ]
}

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • DELETE /lists/{list_id} Delete a list

      Delete a list

      DELETE /lists/{list_id}

      Delete a list from your MailChimp account. If you delete a list, you’ll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.

      Path parameters

      list_id The unique id for the list.

      Example request

      
curl --request DELETE \
--url 'https://usX.api.mailchimp.com/3.0/lists/4ca5becb8d' \
--user 'anystring:apikey' \
--include

      Example response

      
HTTP/1.1 204 No Content
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 2
X-Request-Id: e77507f6-ab70-496a-88a4-3c05684b03b8
Date: Wed, 16 Sep 2015 15:33:21 GMT
Connection: keep-alive

      Error response

      type Type: String Title: Problem Type Read only: false 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 Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.