Mailchimp Conversations API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Conversations 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: Conversations
paths:
  /conversations:
    get:
      summary: Mailchimp List Conversations
      description: Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint.
      operationId: getConversations
      parameters:
      - 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
      - name: has_unread_messages
        x-title: Has Unread Messages
        in: query
        description: Whether the conversation has any unread messages.
        required: false
        type: string
        enum:
        - 'true'
        - 'false'
        example: example_value
      - name: list_id
        x-title: List ID
        in: query
        description: The unique id for the list.
        required: false
        type: string
        example: '500123'
      - name: campaign_id
        x-title: Campaign ID
        in: query
        description: The unique id for the campaign.
        required: false
        type: string
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Tracked Conversations
            description: A collection of this account's tracked conversations.
            properties:
              conversations:
                type: array
                items:
                  type: object
                  title: Conversation
                  description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account.
                  properties:
                    id:
                      type: string
                      title: ID
                      description: A string that uniquely identifies this conversation.
                      readOnly: true
                    message_count:
                      type: integer
                      title: Message Count
                      description: The total number of messages in this conversation.
                      readOnly: true
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: The unique identifier of the campaign for this conversation.
                      readOnly: true
                    list_id:
                      type: string
                      title: List ID
                      description: The unique identifier of the list for this conversation.
                      readOnly: true
                    unread_messages:
                      type: integer
                      title: Unread Messages
                      description: The number of unread messages in this conversation.
                      readOnly: true
                    from_label:
                      type: string
                      title: From Label
                      description: A label representing the sender of this message.
                      readOnly: true
                    from_email:
                      type: string
                      title: From Email
                      description: A label representing the email of the sender of this message.
                      readOnly: true
                    subject:
                      type: string
                      title: Subject
                      description: The subject of the message.
                      readOnly: true
                    last_message:
                      type: object
                      title: Last Message
                      description: The most recent message in the conversation.
                      properties:
                        from_label:
                          type: string
                          title: From Label
                          description: A label representing the sender of this message.
                          readOnly: true
                        from_email:
                          type: string
                          title: From Email
                          description: A label representing the email of the sender of this message.
                          readOnly: true
                        subject:
                          type: string
                          title: Subject
                          description: The subject of this message.
                          readOnly: true
                        message:
                          type: string
                          title: Message
                          description: The plain-text content of the message.
                          readOnly: true
                        read:
                          type: boolean
                          title: Read
                          description: Whether this message has been marked as read.
                        timestamp:
                          type: string
                          title: Timestamp
                          description: The date and time the message was either sent or received in ISO 8601 format.
                          format: date-time
                          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
                title: Conversations
                description: A list of conversations.
              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: true
      tags:
      - Conversations
      x-custom-config:
        methodNameSnake: list
        methodNameCamel: list
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /conversations/{conversation_id}:
    get:
      summary: Mailchimp Get Conversation
      description: Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint.
      operationId: getConversationsId
      parameters:
      - 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
      - in: path
        name: conversation_id
        x-title: Conversation ID
        type: string
        required: true
        description: The unique id for the conversation.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Conversation
            description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account.
            properties:
              id:
                type: string
                title: ID
                description: A string that uniquely identifies this conversation.
                readOnly: true
              message_count:
                type: integer
                title: Message Count
                description: The total number of messages in this conversation.
                readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique identifier of the campaign for this conversation.
                readOnly: true
              list_id:
                type: string
                title: List ID
                description: The unique identifier of the list for this conversation.
                readOnly: true
              unread_messages:
                type: integer
                title: Unread Messages
                description: The number of unread messages in this conversation.
                readOnly: true
              from_label:
                type: string
                title: From Label
                description: A label representing the sender of this message.
                readOnly: true
              from_email:
                type: string
                title: From Email
                description: A label representing the email of the sender of this message.
                readOnly: true
              subject:
                type: string
                title: Subject
                description: The subject of the message.
                readOnly: true
              last_message:
                type: object
                title: Last Message
                description: The most recent message in the conversation.
                properties:
                  from_label:
                    type: string
                    title: From Label
                    description: A label representing the sender of this message.
                    readOnly: true
                  from_email:
                    type: string
                    title: From Email
                    description: A label representing the email of the sender of this message.
                    readOnly: true
                  subject:
                    type: string
                    title: Subject
                    description: The subject of this message.
                    readOnly: true
                  message:
                    type: string
                    title: Message
                    description: The plain-text content of the message.
                    readOnly: true
                  read:
                    type: boolean
                    title: Read
                    description: Whether this message has been marked as read.
                  timestamp:
                    type: string
                    title: Timestamp
                    description: The date and time the message was either sent or received in ISO 8601 format.
                    format: date-time
                    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: true
      tags:
      - Conversations
      x-custom-config:
        methodNameSnake: get
        methodNameCamel: get
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /conversations/{conversation_id}/messages:
    get:
      summary: Mailchimp List Messages
      description: Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint.
      operationId: getConversationsIdMessages
      parameters:
      - 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
      - in: path
        name: conversation_id
        x-title: Conversation ID
        type: string
        required: true
        description: The unique id for the conversation.
        example: '500123'
      - name: is_read
        x-title: Is Read
        in: query
        description: Whether a conversation message has been marked as read.
        required: false
        type: string
        enum:
        - 'true'
        - 'false'
        example: example_value
      - name: before_timestamp
        x-title: Before Timestamp
        in: query
        description: 'Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      - name: since_timestamp
        x-title: Since Timestamp
        in: query
        description: 'Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Collection of Conversation Messages
            description: Messages from a specific conversation.
            properties:
              conversation_messages:
                type: array
                items:
                  type: object
                  title: Conversation Message
                  description: An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account.
                  properties:
                    id:
                      type: string
                      title: ID
                      description: A string that uniquely identifies this message
                      readOnly: true
                    conversation_id:
                      type: string
                      title: Conversation ID
                      description: A string that identifies this message's conversation
                      readOnly: true
                    list_id:
                      type: integer
                      title: List ID
                      description: The list's web ID
                      readOnly: true
                    from_label:
                      type: string
                      title: From Label
                      description: A label representing the sender of this message
                      readOnly: true
                    from_email:
                      type: string
                      title: From Email
                      description: A label representing the email of the sender of this message
                    subject:
                      type: string
                      title: Subject
                      description: The subject of this message
                    message:
                      type: string
                      title: Message
                      description: The plain-text content of the message
                    read:
                      type: boolean
                      title: Read
                      description: Whether this message has been marked as read
                    timestamp:
                      type: string
                      title: Timestamp
                      description: The date and time the message was either sent or received in ISO 8601 format.
                      format: date-time
                      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
                title: Conversation Messages
                description: An array of objects, each representing a conversation messages resources.
              conversation_id:
                type: string
                title: Conversation ID
                description: A string that identifies this conversation.
              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 ca

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