Mailchimp Interests API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Interests API
  contact:
    name: Mailchimp API Support
    email: apihelp@mailchimp.com
  x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json
  description: '

    The Mailchimp Marketing API provides programmatic access to Mailchimp data

    and functionality, allowing developers to build custom features to do

    things like sync email activity and campaign analytics with their

    database, manage audiences and campaigns, and more.'
host: server.api.mailchimp.com
basePath: /3.0
schemes:
- https
consumes:
- application/json
produces:
- application/json
- application/problem+json
security:
- basicAuth: []
tags:
- name: Interests
paths:
  /lists/{list_id}/interest-categories/{interest_category_id}/interests:
    get:
      summary: Mailchimp List Interests in Category
      description: Get a list of this category's interests.
      operationId: getListsIdInterestCategoriesIdInterests
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - name: interest_category_id
        x-title: Interest Category ID
        in: path
        description: The unique ID for the interest category.
        required: true
        type: string
        example: '500123'
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: count
        x-title: Count
        in: query
        description: The number of records to return. Default value is 10. Maximum value is 1000
        required: false
        default: 10
        maximum: 1000
        type: integer
        example: example_value
      - name: offset
        x-title: Offset
        in: query
        description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
        required: false
        default: 0
        type: integer
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Interests
            description: A list of this category's interests
            properties:
              interests:
                type: array
                items:
                  type: object
                  title: Interest
                  description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
                  properties:
                    category_id:
                      type: string
                      title: Interest Category ID
                      description: The id for the interest category.
                      readOnly: true
                    list_id:
                      type: string
                      title: List ID
                      description: The ID for the list that this interest belongs to.
                      readOnly: true
                    id:
                      type: string
                      title: Interest ID
                      description: The ID for the interest.
                      readOnly: true
                    name:
                      type: string
                      title: Interest Name
                      description: The name of the interest. This can be shown publicly on a subscription form.
                    subscriber_count:
                      type: string
                      title: Subscriber Count
                      description: The number of subscribers associated with this interest.
                      readOnly: true
                    display_order:
                      type: integer
                      title: Display Order
                      description: The display order for interests.
                    _links:
                      title: Links
                      description: A list of link types and descriptions for the API schema documents.
                      type: array
                      items:
                        type: object
                        title: Resource Link
                        description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                        properties:
                          rel:
                            type: string
                            title: Rel
                            description: As with an HTML 'rel' attribute, this describes the type of link.
                            readOnly: true
                          href:
                            type: string
                            title: Href
                            description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                            readOnly: true
                          method:
                            type: string
                            title: Method
                            description: The HTTP method that should be used when accessing the URL defined in 'href'.
                            enum:
                            - GET
                            - POST
                            - PUT
                            - PATCH
                            - DELETE
                            - OPTIONS
                            - HEAD
                            readOnly: true
                          targetSchema:
                            type: string
                            title: Target Schema
                            description: For GETs, this is a URL representing the schema that the response should conform to.
                            readOnly: true
                          schema:
                            type: string
                            title: Schema
                            description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                            readOnly: true
                      readOnly: true
                title: Interests
                description: An array of this category's interests
              list_id:
                type: string
                title: List ID
                description: The unique list id that the interests belong to.
              category_id:
                type: string
                title: Interest Category ID
                description: The id for the interest category.
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Interests
      x-custom-config:
        methodNameSnake: list_interest_category_interests
        methodNameCamel: listInterestCategoryInterests
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Interest in Category
      description: Create a new interest or 'group name' for a specific category.
      operationId: postListsIdInterestCategoriesIdInterests
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - name: interest_category_id
        x-title: Interest Category ID
        in: path
        description: The unique ID for the interest category.
        required: true
        type: string
        example: '500123'
      - name: body
        in: body
        required: true
        schema:
          type: object
          title: Interest
          description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
          required:
          - name
          properties:
            name:
              type: string
              title: Interest Name
              description: The name of the interest. This can be shown publicly on a subscription form.
            display_order:
              type: integer
              title: Display Order
              description: The display order for interests.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Interest
            description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
            properties:
              category_id:
                type: string
                title: Interest Category ID
                description: The id for the interest category.
                readOnly: true
              list_id:
                type: string
                title: List ID
                description: The ID for the list that this interest belongs to.
                readOnly: true
              id:
                type: string
                title: Interest ID
                description: The ID for the interest.
                readOnly: true
              name:
                type: string
                title: Interest Name
                description: The name of the interest. This can be shown publicly on a subscription form.
              subscriber_count:
                type: string
                title: Subscriber Count
                description: The number of subscribers associated with this interest.
                readOnly: true
              display_order:
                type: integer
                title: Display Order
                description: The display order for interests.
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Interests
      x-custom-config:
        methodNameSnake: create_interest_category_interest
        methodNameCamel: createInterestCategoryInterest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}:
    get:
      summary: Mailchimp Get Interest in Category
      description: Get interests or 'group names' for a specific category.
      operationId: getListsIdInterestCategoriesIdInterestsId
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - name: interest_category_id
        x-title: Interest Category ID
        in: path
        description: The unique ID for the interest category.
        required: true
        type: string
        example: '500123'
      - name: interest_id
        x-title: Interest ID
        in: path
        description: The specific interest or 'group name'.
        required: true
        type: string
        example: '500123'
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Interest
            description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
            properties:
              category_id:
                type: string
                title: Interest Category ID
                description: The id for the interest category.
                readOnly: true
              list_id:
                type: string
                title: List ID
                description: The ID for the list that this interest belongs to.
                readOnly: true
              id:
                type: string
                title: Interest ID
                description: The ID for the interest.
                readOnly: true
              name:
                type: string
                title: Interest Name
                description: The name of the interest. This can be shown publicly on a subscription form.
              subscriber_count:
                type: string
                title: Subscriber Count
                description: The number of subscribers associated with this interest.
                readOnly: true
              display_order:
                type: integer
                title: Display Order
                description: The display order for interests.
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Interests
      x-custom-config:
        methodNameSnake: get_interest_category_interest
        methodNameCamel: getInterestCategoryInterest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Mailchimp Update Interest in Category
      description: Update interests or 'group names' for a specific category.
      operationId: patchListsIdInterestCategoriesIdInterestsId
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - name: interest_category_id
        x-title: Interest Category ID
        in: path
        description: The unique ID for the interest category.
        required: true
        type: string
        example: '500123'
      - name: interest_id
        x-title: Interest ID
        in: path
        description: The specific interest or 'group name'.
        required: true
        type: string
        example: '500123'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          type: object
          title: Interest
          description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
          required:
          - name
          properties:
            name:
              type: string
              title: Interest Name
              description: The name of the interest. This can be shown publicly on a subscription form.
            display_order:
              type: integer
              title: Display Order
              description: The display order for interests.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Interest
            description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
            properties:
              category_id:
                type: string
                title: Interest Category ID
                description: The id for the interest category.
                readOnly: true
              list_id:
                type: string
                title: List ID
                description: The ID for the list that this interest belongs to.
                readOnly: true
              id:
                type: string
                title: Interest ID
                description: The ID for the interest.
                readOnly: true
              name:
                type: string
                title: Interest Name
                description: The name of the interest. This can be shown publicly on a subscription form.
              subscriber_count:
                type: string
                title: Subscriber Count
                description: The number of subscribers associated with this interest.
                readOnly: true
              display_order:
                type: integer
                title: Display Order
                description: The display order for interests.
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-interests-api-openapi.yml