Members

Manage members of a specific MailChimp list, including currently subscribed, unsubscribed, and bounced members.

Subresources

Available methods

    • POST /lists/{list_id}/members Add a new list member

      Add a new list member

      POST /lists/{list_id}/members

      Add a new member to the list.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      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.

      Response body parameters

      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: false 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
      • transactional
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      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.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/members' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"email_address":"urist.mcvankab+3@freddiesjokes.com", "status":"subscribed"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2468
      Vary: Accept-Encoding
      X-Request-Id: f6d49167-897e-48a3-83c6-e8e0eeef2b8b
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 19:24:29 GMT
      Connection: keep-alive
      
      
      {
        "id": "852aaa9532cb36adfb5e9fef7a4206a9",
        "email_address": "urist.mcvankab+3@freddiesjokes.com",
        "unique_email_id": "fab20fa03d",
        "email_type": "html",
        "status": "subscribed",
        "status_if_new": "",
        "merge_fields": {
          "FNAME": "",
          "LNAME": ""
        },
        "interests": {
          "9143cf3bd1": false,
          "3a2a927344": false,
          "f9c8f5f0ff": false,
          "f231b09abc": false,
          "bd6e66465f": false
        },
        "stats": {
          "avg_open_rate": 0,
          "avg_click_rate": 0
        },
        "ip_signup": "",
        "timestamp_signup": "",
        "ip_opt": "198.2.191.34",
        "timestamp_opt": "2015-09-16 19:24:29",
        "member_rating": 2,
        "last_changed": "2015-09-16 19:24:29",
        "language": "",
        "vip": false,
        "email_client": "",
        "location": {
          "latitude": 0,
          "longitude": 0,
          "gmtoff": 0,
          "dstoff": 0,
          "country_code": "",
          "timezone": ""
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/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": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "method": "DELETE"
          },
          {
            "rel": "activity",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/notes",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.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.
    • GET /lists/{list_id}/members Get information about members in a list
      GET /lists/{list_id}/members/{subscriber_hash} Get information about a specific list member

      Get information about members in a list

      GET /lists/{list_id}/members

      Get information about members in a specific MailChimp list.

      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.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      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. Default value is 0.
      email_type Type: String Title: Email Type Read only: false The email type.
      status Type: String Title: Subscriber Status Read only: false The subscriber’s status.
      since_timestamp_opt Type: String Title: Since Timestamp Opt Read only: false Restrict results to subscribers who opted-in after the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      before_timestamp_opt Type: String Title: Before Timestamp Opt Read only: false Restrict results to subscribers who opted-in before the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
      since_last_changed Type: String Title: Since Last Changed Read only: false Restrict results to subscribers whose information changed after the set timeframe.
      before_last_changed Type: String Title: Before Last Changed Read only: false Restrict results to subscribers whose information changed before the set timeframe.
      unique_email_id Type: String Title: Unique Email ID Read only: false A unique identifier for the email address across all MailChimp lists. This parameter can be found in any links with Ecommerce Tracking enabled.
      vip_only Type: Boolean Title: VIP Only Read only: false A filter to return only the list’s VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.
      interest_category_id Type: String Title: Interest Category ID Read only: false The unique id for the interest category.
      interest_ids Type: String Title: Interest Ids Read only: false Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for the given interest category.
      interest_match Type: String Title: Interest Match Read only: false Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. “any” will match a member with any of the interest supplied, “all” will only match members with every interest supplied, and “none” will match members without any of the interest supplied.
      Possible Values:
      • any
      • all
      • none

      Response body parameters

      members Type: Array Title: Members Read only: false An array of objects, each representing a specific list member.
      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: false 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
      • transactional
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      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.
      list_id Type: String Title: List ID Read only: false The list id.
      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/57afe96172/members' \
      --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: 6d8609bc-e321-4d51-902f-70c5e5d1074f
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 19:15:40 GMT
      Content-Length: 25675
      Connection: keep-alive
      
      
      {
        "members": [
          {
            "id": "f777bbffab8d1ceca8b757df63c47cb8",
            "email_address": "urist.mcvankab+1@freddiesjokes.co",
            "unique_email_id": "882e9bec19",
            "email_type": "html",
            "status": "subscribed",
            "status_if_new": "",
            "merge_fields": {
              "FNAME": "",
              "LNAME": ""
            },
            "interests": {
              "9143cf3bd1": true,
              "3a2a927344": false,
              "f9c8f5f0ff": false,
              "f231b09abc": true,
              "bd6e66465f": false
            },
            "stats": {
              "avg_open_rate": 1,
              "avg_click_rate": 0
            },
            "ip_signup": "198.2.191.34",
            "timestamp_signup": "2015-09-15 17:24:43",
            "ip_opt": "66.249.85.180",
            "timestamp_opt": "2015-09-15 17:27:16",
            "member_rating": 2,
            "last_changed": "2015-09-15 17:27:16",
            "language": "en",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 32.5805,
              "longitude": -97.1389,
              "gmtoff": -6,
              "dstoff": -5,
              "country_code": "US",
              "timezone": "America/Chicago"
            },
            "list_id": "57afe96172",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/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": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/f777bbffab8d1ceca8b757df63c47cb8",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/f777bbffab8d1ceca8b757df63c47cb8/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          },
          {
            "id": "796b7017ce40a94ba27df7a19ff95811",
            "email_address": "urist.mcvankab+2@freddiesjokes.com",
            "unique_email_id": "083ae0451e",
            "email_type": "html",
            "status": "subscribed",
            "status_if_new": "",
            "merge_fields": {
              "FNAME": "",
              "LNAME": ""
            },
            "interests": {
              "9143cf3bd1": true,
              "3a2a927344": false,
              "f9c8f5f0ff": false,
              "f231b09abc": true,
              "bd6e66465f": false
            },
            "stats": {
              "avg_open_rate": 1,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "198.2.191.34",
            "timestamp_opt": "2015-09-15 15:37:03",
            "member_rating": 3,
            "last_changed": "2015-09-15 15:37:03",
            "language": "",
            "vip": false,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "list_id": "57afe96172",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/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": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/f777bbffab8d1ceca8b757df63c47cb8",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/f777bbffab8d1ceca8b757df63c47cb8/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          },
          {
            "id": "62eeb292278cc15f5817cb78f7790b08",
            "email_address": "urist.mcvankab@freddiesjokes.com",
            "unique_email_id": "6ad2993d47",
            "email_type": "html",
            "status": "subscribed",
            "status_if_new": "",
            "merge_fields": {
              "FNAME": "Urist",
              "LNAME": "McVankab"
            },
            "interests": {
              "9143cf3bd1": true,
              "3a2a927344": false,
              "f9c8f5f0ff": false,
              "f231b09abc": true,
              "bd6e66465f": false
            },
            "stats": {
              "avg_open_rate": 0,
              "avg_click_rate": 0
            },
            "ip_signup": "",
            "timestamp_signup": "",
            "ip_opt": "198.2.191.34",
            "timestamp_opt": "2015-09-15 14:40:01",
            "member_rating": 2,
            "last_changed": "2015-09-15 14:40:01",
            "language": "",
            "vip": true,
            "email_client": "",
            "location": {
              "latitude": 0,
              "longitude": 0,
              "gmtoff": 0,
              "dstoff": 0,
              "country_code": "",
              "timezone": ""
            },
            "last_note": {
              "note_id": 10505,
              "created_at": "2015-09-15 14:44:14",
              "created_by": "2945082",
              "note": "Urist's favorite Freddie joke to date is \"Keep on poppin' and lockin' in the free world!\""
            },
            "list_id": "57afe96172",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/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": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/62eeb292278cc15f5817cb78f7790b08",
                "method": "DELETE"
              },
              {
                "rel": "activity",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/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/57afe96172/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/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json"
              }
            ]
          }
        ],
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "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": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
          }
        ],
        "total_items": 204
      }
                                      

      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 member

      GET /lists/{list_id}/members/{subscriber_hash}

      Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.

      Path parameters

      list_id The unique id for the list.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      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: 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: false 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
      • transactional
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      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.

      Example request

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

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2468
      Vary: Accept-Encoding
      X-Request-Id: 0f18f1e0-ada5-444a-81d4-e7bd42341c48
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 19:30:12 GMT
      Connection: keep-alive
      
      
      {
        "id": "852aaa9532cb36adfb5e9fef7a4206a9",
        "email_address": "urist.mcvankab+3@freddiesjokes.com",
        "unique_email_id": "fab20fa03d",
        "email_type": "html",
        "status": "subscribed",
        "status_if_new": "",
        "merge_fields": {
          "FNAME": "",
          "LNAME": ""
        },
        "interests": {
          "9143cf3bd1": false,
          "3a2a927344": false,
          "f9c8f5f0ff": false,
          "f231b09abc": false,
          "bd6e66465f": false
        },
        "stats": {
          "avg_open_rate": 0,
          "avg_click_rate": 0
        },
        "ip_signup": "",
        "timestamp_signup": "",
        "ip_opt": "198.2.191.34",
        "timestamp_opt": "2015-09-16 19:24:29",
        "member_rating": 2,
        "last_changed": "2015-09-16 19:24:29",
        "language": "",
        "vip": false,
        "email_client": "",
        "location": {
          "latitude": 0,
          "longitude": 0,
          "gmtoff": 0,
          "dstoff": 0,
          "country_code": "",
          "timezone": ""
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/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": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9",
            "method": "DELETE"
          },
          {
            "rel": "activity",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/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/57afe96172/members/852aaa9532cb36adfb5e9fef7a4206a9/notes",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.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.
    • Update a list member

      PATCH /lists/{list_id}/members/{subscriber_hash}

      Update information for a specific list member.

      Path parameters

      list_id The unique id for the list.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      Request body parameters

      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.

      Response body parameters

      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: false 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
      • transactional
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      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.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381' \
      --user 'anystring:apikey' \
      --data '{"email_address":"urist.mcvankab+8@freddiesjokes.com", "status":"unsubscribed"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2470
      Vary: Accept-Encoding
      X-Request-Id: 55ea0fc6-e524-44ec-a823-c17b5780d3ce
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:25:26 GMT
      Connection: keep-alive
      
      
      {
        "id": "20dbbf20d91106a9377bb671ba83f381",
        "email_address": "urist.mcvankab+8@freddiesjokes.com",
        "unique_email_id": "50c27a90af",
        "email_type": "html",
        "status": "unsubscribed",
        "status_if_new": "",
        "merge_fields": {
          "FNAME": "",
          "LNAME": ""
        },
        "interests": {
          "9143cf3bd1": false,
          "3a2a927344": false,
          "f9c8f5f0ff": false,
          "f231b09abc": false,
          "bd6e66465f": false
        },
        "stats": {
          "avg_open_rate": 0,
          "avg_click_rate": 0
        },
        "ip_signup": "",
        "timestamp_signup": "",
        "ip_opt": "198.2.191.34",
        "timestamp_opt": "2015-09-16 20:23:55",
        "member_rating": 2,
        "last_changed": "2015-09-16 20:25:26",
        "language": "",
        "vip": false,
        "email_client": "",
        "location": {
          "latitude": 0,
          "longitude": 0,
          "gmtoff": 0,
          "dstoff": 0,
          "country_code": "",
          "timezone": ""
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/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": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "method": "DELETE"
          },
          {
            "rel": "activity",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/notes",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.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.

      Add or update a list member

      PUT /lists/{list_id}/members/{subscriber_hash}

      Add or update a list member.

      Path parameters

      list_id The unique id for the list.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      Request body parameters

      email_address Type: String Title: Email Address Read only: false Email address for a subscriber. This value is required only if the email address is not already present on the list.
      status_if_new Type: String Title: New Member Status Read only: false Subscriber’s status. This value is required only if the email address is not already present on the list.
      Possible Values:
      • subscribed
      • unsubscribed
      • cleaned
      • pending
      • transactional
      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.

      Response body parameters

      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: false 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
      • transactional
      unsubscribe_reason Type: String Title: Unsubscribe Reason Read only: false A subscriber’s reason for unsubscribing.
      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.

      Example request

      
      curl --request PUT \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381' \
      --user 'anystring:apikey' \
      --data '{"email_address":"urist.mcvankab+8@freddiesjokes.com", "status_if_new":"subscribed"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2468
      Vary: Accept-Encoding
      X-Request-Id: c0e52df8-3770-4e57-b8e6-ea7aa2436a5a
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:23:55 GMT
      Connection: keep-alive
      
      
      {
        "id": "20dbbf20d91106a9377bb671ba83f381",
        "email_address": "urist.mcvankab+8@freddiesjokes.com",
        "unique_email_id": "50c27a90af",
        "email_type": "html",
        "status": "subscribed",
        "status_if_new": "",
        "merge_fields": {
          "FNAME": "",
          "LNAME": ""
        },
        "interests": {
          "9143cf3bd1": false,
          "3a2a927344": false,
          "f9c8f5f0ff": false,
          "f231b09abc": false,
          "bd6e66465f": false
        },
        "stats": {
          "avg_open_rate": 0,
          "avg_click_rate": 0
        },
        "ip_signup": "",
        "timestamp_signup": "",
        "ip_opt": "198.2.191.34",
        "timestamp_opt": "2015-09-16 20:23:55",
        "member_rating": 2,
        "last_changed": "2015-09-16 20:23:55",
        "language": "",
        "vip": false,
        "email_client": "",
        "location": {
          "latitude": 0,
          "longitude": 0,
          "gmtoff": 0,
          "dstoff": 0,
          "country_code": "",
          "timezone": ""
        },
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/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": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381",
            "method": "DELETE"
          },
          {
            "rel": "activity",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/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/57afe96172/members/20dbbf20d91106a9377bb671ba83f381/notes",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.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.
    • Remove a list member

      DELETE /lists/{list_id}/members/{subscriber_hash}

      Delete a member from a list.

      Path parameters

      list_id The unique id for the list.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/20dbbf20d91106a9377bb671ba83f381' \
      --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: 0e71b16c-d99f-4651-b2e5-ea39747f44e0
      Date: Wed, 16 Sep 2015 20:29:37 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.