Mailchimp Activity Feed API

openapi: 3.2.0
info:
  contact:
    email: apihelp@mailchimp.com
    name: Mailchimp API Support
  description: 'Whether you’re managing your own campaigns, providing Mailchimp services to your customers or clients, or writing a mobile app, the Mailchimp API has features to manage and sync your contact data.


    Audiences are at the core of sending campaigns with Mailchimp. You can use the API to set up an audience and add contacts to that audience; you can then organize those contacts with tags or segment them by activity with events.


    The API can also be a source of data for your application. Webhooks collect and transmit information about your audience to you in near real time. And if you’re selling products on an external store, you can integrate your audience behavior using Mailchimp’s E-commerce features.


    You can also use the API to handle data in different ways for different purposes. If you are syncing a large amount of data with Mailchimp, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Mailchimp accounts, you should authenticate with OAuth 2. And if you’re developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the API’s functionality.'
  summary: Manage audiences, integrate your data, and send timely, relevant email campaigns.
  termsOfService: https://mailchimp.com/legal/api_use/
  title: Mailchimp Activity Feed API
  version: 0.1.0-dev
servers:
- description: Mailchimp API
  url: https://api.mailchimp.com
security:
- bearerToken: []
- oauth2: []
tags:
- name: activity-feed
paths:
  /3.0/activity-feed:
    get:
      description: Get information about the activity feed endpoint's resources.
      operationId: getActivityFeed
      responses:
        '200':
          content:
            application/json:
              schema:
                description: A list of link types and descriptions for the API schema documents.
                items:
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    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
                      title: Href
                      type: string
                    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
                      title: Method
                      type: string
                    rel:
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                      title: Rel
                      type: string
                    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
                      title: Schema
                      type: string
                    targetSchema:
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                      title: Target Schema
                      type: string
                  title: Resource Link
                  type: object
                readOnly: true
                title: Links
                type: array
          description: ''
        default:
          content:
            application/problem+json:
              schema:
                description: 'An error generated by the Mailchimp API. The response conforms to [RFC 9457: Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).'
                properties:
                  detail:
                    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).
                    examples:
                    - The requested resource could not be found.
                    title: Error Message
                    type: string
                  instance:
                    description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                    examples:
                    - 995c5cb0-3280-4a6e-808b-3b096d0bb219
                    title: Instance ID
                    type: string
                  status:
                    description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                    examples:
                    - 404
                    title: HTTP Status Code
                    type: integer
                  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.
                    examples:
                    - Resource Not Found
                    title: Error Title
                    type: string
                  type:
                    description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                    examples:
                    - https://mailchimp.com/developer/marketing/docs/errors/
                    title: Problem Type
                    type: string
                required:
                - detail
                - instance
                - status
                - title
                - type
                title: Problem Detail Document
                type: object
          description: An error generated by the Mailchimp API.
      summary: List activity feed resources
      tags:
      - activity-feed
      x-custom-config:
        methodNameCamel: get
        methodNameSnake: get
  /3.0/activity-feed/chimp-chatter:
    get:
      description: Return the Chimp Chatter for this account ordered by most recent.
      operationId: getActivityFeedChimpChatter
      parameters:
      - description: The number of records to return. Default value is 10. Maximum value is 1000
        in: query
        name: count
        schema:
          default: 10
          maximum: 1000
          type: integer
          x-title: Count
        x-title: Count
      - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.
        in: query
        name: offset
        schema:
          default: 0
          type: integer
          x-title: Offset
        x-title: Offset
      responses:
        '200':
          content:
            application/json:
              schema:
                description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                properties:
                  _links:
                    description: A list of link types and descriptions for the API schema documents.
                    items:
                      description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                      properties:
                        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
                          title: Href
                          type: string
                        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
                          title: Method
                          type: string
                        rel:
                          description: As with an HTML 'rel' attribute, this describes the type of link.
                          readOnly: true
                          title: Rel
                          type: string
                        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
                          title: Schema
                          type: string
                        targetSchema:
                          description: For GETs, this is a URL representing the schema that the response should conform to.
                          readOnly: true
                          title: Target Schema
                          type: string
                      title: Resource Link
                      type: object
                    readOnly: true
                    title: Links
                    type: array
                  chimp_chatter:
                    description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                    items:
                      description: A Chimp Chatter message
                      properties:
                        campaign_id:
                          description: If it exists, campaign ID for the associated campaign
                          example: '2017-08-04T11:09:01+00:00'
                          readOnly: true
                          title: Campaign ID
                          type: string
                        list_id:
                          description: If it exists, list ID for the associated list
                          example: '2017-08-04T11:09:01+00:00'
                          readOnly: true
                          title: List ID
                          type: string
                        message:
                          example: People are telling their friends about your campaign!
                          readOnly: true
                          title: Message
                          type: string
                        title:
                          example: 1 new subscriber to Your New Campaign!
                          readOnly: true
                          title: Title
                          type: string
                        type:
                          description: The type of activity
                          enum:
                          - lists:new-subscriber
                          - lists:unsubscribes
                          - lists:profile-updates
                          - campaigns:facebook-likes
                          - campaigns:forward-to-friend
                          - lists:imports
                          example: campaigns:forward-to-friend
                          readOnly: true
                          title: Type
                          type: string
                        update_time:
                          description: The date and time this activity was updated.
                          example: '2017-08-04T11:09:01+00:00'
                          format: date-time
                          readOnly: true
                          title: Update Time
                          type: string
                        url:
                          description: URL to a report that includes this activity
                          example: http://dev.mailchimp.com/reports/summary?id=1
                          readOnly: true
                          title: URL
                          type: string
                      title: ChimpChatter
                      type: object
                    readOnly: true
                    type: array
                  total_items:
                    description: The total number of items matching the query regardless of pagination.
                    readOnly: true
                    title: Item Count
                    type: integer
                type: object
          description: ChimpChatter Collection
        default:
          content:
            application/problem+json:
              schema:
                description: 'An error generated by the Mailchimp API. The response conforms to [RFC 9457: Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).'
                properties:
                  detail:
                    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).
                    examples:
                    - The requested resource could not be found.
                    title: Error Message
                    type: string
                  instance:
                    description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                    examples:
                    - 995c5cb0-3280-4a6e-808b-3b096d0bb219
                    title: Instance ID
                    type: string
                  status:
                    description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                    examples:
                    - 404
                    title: HTTP Status Code
                    type: integer
                  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.
                    examples:
                    - Resource Not Found
                    title: Error Title
                    type: string
                  type:
                    description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                    examples:
                    - https://mailchimp.com/developer/marketing/docs/errors/
                    title: Problem Type
                    type: string
                required:
                - detail
                - instance
                - status
                - title
                - type
                title: Problem Detail Document
                type: object
          description: An error generated by the Mailchimp API.
      summary: Get latest chimp chatter
      tags:
      - activity-feed
      x-custom-config:
        methodNameCamel: getChimpChatter
        methodNameSnake: get_chimp_chatter
  /activity-feed/chimp-chatter:
    get:
      summary: Get latest chimp chatter
      description: Return the Chimp Chatter for this account ordered by most recent.
      parameters:
      - name: count
        x-title: Count
        in: query
        description: The number of records to return. Default value is 10. Maximum value is 1000
        required: false
        schema:
          type: integer
          default: 10
          maximum: 1000
      - name: offset
        x-title: Offset
        in: query
        description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.
        required: false
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: ChimpChatter Collection
          content:
            application/json:
              schema:
                type: object
                description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                properties:
                  chimp_chatter:
                    type: array
                    description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                    readOnly: true
                    items:
                      type: object
                      title: ChimpChatter
                      description: A Chimp Chatter message
                      properties:
                        title:
                          type: string
                          title: Title
                          readOnly: true
                          example: 1 new subscriber to Your New Campaign!
                        message:
                          type: string
                          title: Message
                          readOnly: true
                          example: People are telling their friends about your campaign!
                        type:
                          type: string
                          title: Type
                          description: The type of activity
                          enum:
                          - lists:new-subscriber
                          - lists:unsubscribes
                          - lists:profile-updates
                          - campaigns:facebook-likes
                          - campaigns:forward-to-friend
                          - lists:imports
                          readOnly: true
                          example: campaigns:forward-to-friend
                        update_time:
                          type: string
                          title: Update Time
                          format: date-time
                          description: The date and time this activity was updated.
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                        url:
                          type: string
                          title: URL
                          description: URL to a report that includes this activity
                          readOnly: true
                          example: http://dev.mailchimp.com/reports/summary?id=1
                        list_id:
                          type: string
                          title: List ID
                          description: If it exists, list ID for the associated list
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                        campaign_id:
                          type: string
                          title: Campaign ID
                          description: If it exists, campaign ID for the associated campaign
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                  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
            application/problem+json:
              schema:
                type: object
                description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                properties:
                  chimp_chatter:
                    type: array
                    description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                    readOnly: true
                    items:
                      type: object
                      title: ChimpChatter
                      description: A Chimp Chatter message
                      properties:
                        title:
                          type: string
                          title: Title
                          readOnly: true
                          example: 1 new subscriber to Your New Campaign!
                        message:
                          type: string
                          title: Message
                          readOnly: true
                          example: People are telling their friends about your campaign!
                        type:
                          type: string
                          title: Type
                          description: The type of activity
                          enum:
                          - lists:new-subscriber
                          - lists:unsubscribes
                          - lists:profile-updates
                          - campaigns:facebook-likes
                          - campaigns:forward-to-friend
                          - lists:imports
                          readOnly: true
                          example: campaigns:forward-to-friend
                        update_time:
                          type: string
                          title: Update Time
                          format: date-time
                          description: The date and time this activity was updated.
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                        url:
                          type: string
                          title: URL
                          description: URL to a report that includes this activity
                          readOnly: true
                          example: http://dev.mailchimp.com/reports/summary?id=1
                        list_id:
                          type: string
                          title: List ID
                          description: If it exists, list ID for the associated list
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                        campaign_id:
                          type: string
                          title: Campaign ID
                          description: If it exists, campaign ID for the associated campaign
                          readOnly: true
                          example: '2017-08-04T11:09:01+00:00'
                  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.
          content:
            application/json:
              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
            application/problem+json:
              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
      tags:
      - Activity Feed
      x-custom-config:
        methodNameSnake: get_chimp_chatter
        methodNameCamel: getChimpChatter
      operationId: getActivityFeedChimpChatter
components:
  securitySchemes:
    bearerToken:
      description: Authorization using a Mailchimp API key (a.k.a. Bearer token)
      scheme: Bearer
      type: http
    oauth2:
      description: Authorization using OAuth
      flows:
        authorizationCode:
          authorizationUrl: https://login.mailchimp.com/oauth2/authorize
          scopes: {}
          tokenUrl: https://login.mailchimp.com/oauth2/token
      type: oauth2
    basicAuth:
      type: http
      scheme: basic