Member Notes

Retrieve recent notes for a specific list member.

Available methods

    • Add a new note

      POST /lists/{list_id}/members/{subscriber_hash}/notes

      Add a new note for a specific subscriber.

      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

      note Type: String Title: Note Read only: false The content of the note.

      Response body parameters

      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.
      updated_at Type: String Title: Updated Time Read only: true The date and time the note was last updated.
      note Type: String Title: Note Read only: false The content of the note.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      _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/62eeb292278cc15f5817cb78f7790b08/notes' \
      --user 'anystring:apikey' \
      --data '{"note":"Urist came to the site today and purchased three new Freddie bags."}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1128
      Vary: Accept-Encoding
      X-Request-Id: 03fe8e86-dda0-411f-89ad-f36a708d42db
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:41:03 GMT
      Connection: keep-alive
      
      
      {
        "id": 10509,
        "created_at": "2015-09-16T20:41:03+00:00",
        "created_by": "Freddie Jokes",
        "updated_at": "2015-09-16T20:41:03+00:00",
        "note": "Urist came to the site today and purchased three new Freddie bags.",
        "list_id": "57afe96172",
        "email_id": "62eeb292278cc15f5817cb78f7790b08",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "parent",
            "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"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "DELETE"
          }
        ]
      }
                                      

      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/{subscriber_hash}/notes Get recent notes for a specific list member
      GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Get a specific note for a specific list member

      Get recent notes for a specific list member

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

      Get recent notes 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.

      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.

      Response body parameters

      notes Type: Array Title: Notes Read only: false An array of objects, each representing a note resource.
      Show properties
      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.
      updated_at Type: String Title: Updated Time Read only: true The date and time the note was last updated.
      note Type: String Title: Note Read only: false The content of the note.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      _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.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      list_id Type: String Title: List ID Read only: true 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/62eeb292278cc15f5817cb78f7790b08/notes' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1937
      Vary: Accept-Encoding
      X-Request-Id: f3d9d0dc-52d7-4a1d-b3ae-2e68a94c2496
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:38:58 GMT
      Connection: keep-alive
      
      
      {
        "notes": [
          {
            "id": 10505,
            "created_at": "2015-09-15T14:44:14+00:00",
            "created_by": "Freddie Jokes",
            "updated_at": "2015-09-15T14:44:14+00:00",
            "note": "Urist's favorite Freddie joke to date is \"Keep on poppin' and lockin' in the free world!\"",
            "list_id": "57afe96172",
            "email_id": "62eeb292278cc15f5817cb78f7790b08",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10505",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
              },
              {
                "rel": "parent",
                "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"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10505",
                "method": "PATCH",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10505",
                "method": "DELETE"
              }
            ]
          }
        ],
        "email_id": "62eeb292278cc15f5817cb78f7790b08",
        "list_id": "57afe96172",
        "_links": [
          {
            "rel": "self",
            "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"
          },
          {
            "rel": "parent",
            "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": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/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 a specific note for a specific list member

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

      Get a specific note 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.
      note_id The id for the note.

      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: 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.
      updated_at Type: String Title: Updated Time Read only: true The date and time the note was last updated.
      note Type: String Title: Note Read only: false The content of the note.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      _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/62eeb292278cc15f5817cb78f7790b08/notes/10509' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1128
      Vary: Accept-Encoding
      X-Request-Id: 1543097e-cde2-421c-bd4a-49aa25f93cae
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:47:18 GMT
      Connection: keep-alive
      
      
      {
        "id": 10509,
        "created_at": "2015-09-16T20:41:03+00:00",
        "created_by": "Freddie Jokes",
        "updated_at": "2015-09-16T20:41:03+00:00",
        "note": "Urist came to the site today and purchased three new Freddie bags.",
        "list_id": "57afe96172",
        "email_id": "62eeb292278cc15f5817cb78f7790b08",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "parent",
            "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"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "DELETE"
          }
        ]
      }
                                      

      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 note

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

      Update a specific note 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.
      note_id The id for the note.

      Request body parameters

      note Type: String Title: Note Read only: false The content of the note.

      Response body parameters

      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.
      updated_at Type: String Title: Updated Time Read only: true The date and time the note was last updated.
      note Type: String Title: Note Read only: false The content of the note.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      _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/62eeb292278cc15f5817cb78f7790b08/notes/10509' \
      --user 'anystring:apikey' \
      --data '{"note":"Urist visited the site today and added 3 Freddie totes to his cart, but didn'\''t purchase them."}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1155
      Vary: Accept-Encoding
      X-Request-Id: a54ea523-0b7d-4be3-a18a-b7fe3e1a6abe
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:49:10 GMT
      Connection: keep-alive
      
      
      {
        "id": 10509,
        "created_at": "2015-09-16T20:41:03+00:00",
        "created_by": "Freddie Jokes",
        "updated_at": "2015-09-16T20:49:10+00:00",
        "note": "Urist visited the site today and added 3 Freddie totes to his cart, but didn't purchase them.",
        "list_id": "57afe96172",
        "email_id": "62eeb292278cc15f5817cb78f7790b08",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "parent",
            "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"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "PATCH",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Notes/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509",
            "method": "DELETE"
          }
        ]
      }
                                      

      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 a note

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

      Delete a specific note 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.
      note_id The id for the note.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/notes/10509' \
      --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: 3487849e-767c-411a-96de-103d5b99c2d7
      Date: Wed, 16 Sep 2015 20:51:13 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.