Interests

Manage interests for a specific MailChimp list. Assign subscribers to interests to group them together. Interests are referred to as ‘group names’ in the MailChimp application. Learn more about using groups in MailChimp.

Available methods

    • Create a new interest in a specific category

      POST /lists/{list_id}/interest-categories/{interest_category_id}/interests

      Create a new interest or ‘group name’ for a specific category.

      Path parameters

      list_id The unique id for the list.
      interest_category_id The unique id for the interest category.

      Request body parameters

      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.

      Response body parameters

      category_id Type: String Title: Interest Category ID Read only: true The id for the interest category.
      list_id Type: String Title: List ID Read only: true The ID for the list that this interest belongs to.
      id Type: String Title: Interest ID Read only: true The ID for the interest.
      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      subscriber_count Type: String Title: Subscriber Count Read only: true The number of subscribers associated with this interest.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.
      _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/interest-categories/a1e9f4b7f6/interests/a1e9f4b7f6/interests' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name":"Wait, I'\''ve got something stuck in my teeth."}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1156
      Vary: Accept-Encoding
      X-Request-Id: d4e58e42-395f-47f9-a543-d977f8dec2bc
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 18:44:11 GMT
      Connection: keep-alive
      
      
      {
        "category_id": "a1e9f4b7f6",
        "list_id": "57afe96172",
        "id": "9112523ad7",
        "name": "Wait, I've got something stuck in my teeth.",
        "display_order": 6,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "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 all interests in a specific category

      GET /lists/{list_id}/interest-categories/{interest_category_id}/interests

      Get a list of this category’s interests.

      Path parameters

      list_id The unique id for the list.
      interest_category_id The unique id for the interest category.

      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

      interests Type: Array Title: Interests Read only: false An array of this category’s interests
      Show properties
      category_id Type: String Title: Interest Category ID Read only: true The id for the interest category.
      list_id Type: String Title: List ID Read only: true The ID for the list that this interest belongs to.
      id Type: String Title: Interest ID Read only: true The ID for the interest.
      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      subscriber_count Type: String Title: Subscriber Count Read only: true The number of subscribers associated with this interest.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.
      _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 unique list id that the interests belong to.
      category_id Type: String Title: Interest Category ID Read only: false The id for the interest category.
      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/interest-categories/a1e9f4b7f6/interests' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 6702
      Vary: Accept-Encoding
      X-Request-Id: 09f1d0b7-c64d-4d5f-b47f-61cf427f2ba0
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 18:37:43 GMT
      Connection: keep-alive
      
      
      {
        "interests": [
          {
            "category_id": "a1e9f4b7f6",
            "list_id": "57afe96172",
            "id": "9143cf3bd1",
            "name": "Sometimes you just gotta 'spress yourself.",
            "display_order": 1,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9143cf3bd1",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9143cf3bd1",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9143cf3bd1",
                "method": "DELETE"
              }
            ]
          },
          {
            "category_id": "a1e9f4b7f6",
            "list_id": "57afe96172",
            "id": "3a2a927344",
            "name": "I'm just a poor boy from a poor family.",
            "display_order": 2,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/3a2a927344",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/3a2a927344",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/3a2a927344",
                "method": "DELETE"
              }
            ]
          },
          {
            "category_id": "a1e9f4b7f6",
            "list_id": "57afe96172",
            "id": "f9c8f5f0ff",
            "name": "What's with all these cute kittens?",
            "display_order": 3,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f9c8f5f0ff",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f9c8f5f0ff",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f9c8f5f0ff",
                "method": "DELETE"
              }
            ]
          },
          {
            "category_id": "a1e9f4b7f6",
            "list_id": "57afe96172",
            "id": "f231b09abc",
            "name": "I knock your socks off with my beat box.",
            "display_order": 4,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f231b09abc",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f231b09abc",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/f231b09abc",
                "method": "DELETE"
              }
            ]
          },
          {
            "category_id": "a1e9f4b7f6",
            "list_id": "57afe96172",
            "id": "bd6e66465f",
            "name": "Two chimps walk into a bar. The other chimp ducks.",
            "display_order": 5,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/bd6e66465f",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/bd6e66465f",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
                "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/bd6e66465f",
                "method": "DELETE"
              }
            ]
          }
        ],
        "list_id": "57afe96172",
        "category_id": "a1e9f4b7f6",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
            "method": "POST",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          }
        ],
        "total_items": 5
      }
                                      

      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 interests in a specific category

      GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

      Get interests or ‘group names’ for a specific category.

      Path parameters

      list_id The unique id for the list.
      interest_category_id The unique id for the interest category.
      interest_id The specific interest or ‘group name’.

      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

      category_id Type: String Title: Interest Category ID Read only: true The id for the interest category.
      list_id Type: String Title: List ID Read only: true The ID for the list that this interest belongs to.
      id Type: String Title: Interest ID Read only: true The ID for the interest.
      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      subscriber_count Type: String Title: Subscriber Count Read only: true The number of subscribers associated with this interest.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.
      _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/interest-categories/a1e9f4b7f6/interests/a1e9f4b7f6/interests/9112523ad7' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1156
      Vary: Accept-Encoding
      X-Request-Id: ee9d6ff4-663f-4811-b3f0-a6dc8f5bad3c
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 18:46:11 GMT
      Connection: keep-alive
      
      
      {
        "category_id": "a1e9f4b7f6",
        "list_id": "57afe96172",
        "id": "9112523ad7",
        "name": "Wait, I've got something stuck in my teeth.",
        "display_order": 6,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "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 interests in a specific category

      PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

      Update interests or ‘group names’ for a specific category.

      Path parameters

      list_id The unique id for the list.
      interest_category_id The unique id for the interest category.
      interest_id The specific interest or ‘group name’.

      Request body parameters

      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.

      Response body parameters

      category_id Type: String Title: Interest Category ID Read only: true The id for the interest category.
      list_id Type: String Title: List ID Read only: true The ID for the list that this interest belongs to.
      id Type: String Title: Interest ID Read only: true The ID for the interest.
      name Type: String Title: Interest Name Read only: false The name of the interest. This can be shown publicly on a subscription form.
      subscriber_count Type: String Title: Subscriber Count Read only: true The number of subscribers associated with this interest.
      display_order Type: Integer Title: Display Order Read only: false The display order for interests.
      _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/interest-categories/a1e9f4b7f6/interests/9112523ad7' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name":"Wait, I'\''ve got something stuck in my teeth.", "display_order": 4}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1156
      Vary: Accept-Encoding
      X-Request-Id: f8e0d197-26e2-4681-937a-24237469cb61
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 18:51:11 GMT
      Connection: keep-alive
      
      
      {
        "category_id": "a1e9f4b7f6",
        "list_id": "57afe96172",
        "id": "9112523ad7",
        "name": "Wait, I've got something stuck in my teeth.",
        "display_order": 4,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Interests.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Interests/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7",
            "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 interests in a specific category

      DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

      Delete interests or group names in a specific category.

      Path parameters

      list_id The unique id for the list.
      interest_category_id The unique id for the interest category.
      interest_id The specific interest or ‘group name’.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/interest-categories/a1e9f4b7f6/interests/9112523ad7' \
      --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: 84228a64-c492-4c84-945b-2e1d3838b95b
      Date: Wed, 16 Sep 2015 19:01:03 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.