Mailchimp Root API

openapi: 3.2.0
info:
  version: 3.0.91
  title: Mailchimp Marketing Root 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
servers:
- url: https://server.api.mailchimp.com/3.0
security:
- basicAuth: []
tags:
- name: root
paths:
  /:
    get:
      summary: List api root resources
      description: Get links to all other resources available in the API.
      operationId: getRoot
      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
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - 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
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                title: API Root
                description: The API root resource links to all other resources available in the API.
                properties:
                  account_id:
                    type: string
                    title: Account ID
                    description: The Mailchimp account ID.
                    readOnly: true
                  login_id:
                    type: string
                    title: Login ID
                    description: The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account.
                    readOnly: true
                  account_name:
                    type: string
                    title: Account Name
                    description: The name of the account.
                    readOnly: true
                  email:
                    type: string
                    title: Account Email
                    description: The account email address.
                    readOnly: true
                  first_name:
                    type: string
                    title: First Name
                    description: The first name tied to the account.
                    readOnly: true
                  last_name:
                    type: string
                    title: Last Name
                    description: The last name tied to the account.
                    readOnly: true
                  username:
                    type: string
                    title: User Name
                    description: The username tied to the account.
                    readOnly: true
                    example: freddie2000
                  avatar_url:
                    type: string
                    title: Avatar URL
                    description: URL of the avatar for the user.
                    readOnly: true
                  role:
                    type: string
                    title: Role
                    description: The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account.
                    readOnly: true
                  member_since:
                    type: string
                    title: Account Creation Date
                    format: date-time
                    description: The date and time that the account was created in ISO 8601 format.
                    readOnly: true
                    example: '2010-01-01T23:59:59+00:00'
                  pricing_plan_type:
                    type: string
                    title: Account Pricing Plan
                    description: The type of pricing plan the account is on.
                    enum:
                    - monthly
                    - pay_as_you_go
                    - forever_free
                    readOnly: true
                  first_payment:
                    type: string
                    title: First Payment
                    format: date-time
                    description: Date of first payment for monthly plans.
                    readOnly: true
                    example: '2010-01-01T23:59:59+00:00'
                  account_timezone:
                    type: string
                    title: Account Timezone
                    description: The timezone currently set for the account.
                    readOnly: true
                  account_industry:
                    type: string
                    title: Account Industry
                    description: The user-specified industry associated with the account.
                    readOnly: true
                  contact:
                    type: object
                    title: Account Contact
                    description: Information about the account contact.
                    readOnly: true
                    properties:
                      company:
                        type: string
                        title: Company
                        description: The company name for the account.
                        readOnly: true
                      addr1:
                        type: string
                        title: Address Line 1
                        description: The street address for the account contact.
                        readOnly: true
                      addr2:
                        type: string
                        title: Address Line 2
                        description: The street address for the account contact.
                        readOnly: true
                      city:
                        type: string
                        title: City
                        description: The city for the account contact.
                        readOnly: true
                      state:
                        type: string
                        title: State
                        description: The state for the account contact.
                        readOnly: true
                      zip:
                        type: string
                        title: Zip Code
                        description: The zip code for the account contact.
                        readOnly: true
                      country:
                        type: string
                        title: Country
                        description: The country for the account contact.
                        readOnly: true
                  pro_enabled:
                    type: boolean
                    title: Mailchimp Pro
                    description: Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-legacy-pricing-plan/).
                    readOnly: true
                  last_login:
                    type: string
                    title: Last Login Date
                    description: The date and time of the last login for this account in ISO 8601 format.
                    readOnly: true
                    format: date-time
                  total_subscribers:
                    type: integer
                    title: Total Subscribers
                    description: The total number of subscribers across all lists in the account.
                    readOnly: true
                  industry_stats:
                    type: object
                    title: Industry Stats
                    description: The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry.
                    readOnly: true
                    properties:
                      open_rate:
                        type: number
                        title: Open Rate
                        description: The average unique open rate for all campaigns in the account's specified industry.
                        readOnly: true
                      bounce_rate:
                        type: number
                        title: Bounce Rate
                        description: The average bounce rate for all campaigns in the account's specified industry.
                        readOnly: true
                      click_rate:
                        type: number
                        title: Click Rate
                        description: The average unique click rate for all campaigns in the account's specified industry.
                        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
                title: API Root
                description: The API root resource links to all other resources available in the API.
                properties:
                  account_id:
                    type: string
                    title: Account ID
                    description: The Mailchimp account ID.
                    readOnly: true
                  login_id:
                    type: string
                    title: Login ID
                    description: The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account.
                    readOnly: true
                  account_name:
                    type: string
                    title: Account Name
                    description: The name of the account.
                    readOnly: true
                  email:
                    type: string
                    title: Account Email
                    description: The account email address.
                    readOnly: true
                  first_name:
                    type: string
                    title: First Name
                    description: The first name tied to the account.
                    readOnly: true
                  last_name:
                    type: string
                    title: Last Name
                    description: The last name tied to the account.
                    readOnly: true
                  username:
                    type: string
                    title: User Name
                    description: The username tied to the account.
                    readOnly: true
                    example: freddie2000
                  avatar_url:
                    type: string
                    title: Avatar URL
                    description: URL of the avatar for the user.
                    readOnly: true
                  role:
                    type: string
                    title: Role
                    description: The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account.
                    readOnly: true
                  member_since:
                    type: string
                    title: Account Creation Date
                    format: date-time
                    description: The date and time that the account was created in ISO 8601 format.
                    readOnly: true
                    example: '2010-01-01T23:59:59+00:00'
                  pricing_plan_type:
                    type: string
                    title: Account Pricing Plan
                    description: The type of pricing plan the account is on.
                    enum:
                    - monthly
                    - pay_as_you_go
                    - forever_free
                    readOnly: true
                  first_payment:
                    type: string
                    title: First Payment
                    format: date-time
                    description: Date of first payment for monthly plans.
                    readOnly: true
                    example: '2010-01-01T23:59:59+00:00'
                  account_timezone:
                    type: string
                    title: Account Timezone
                    description: The timezone currently set for the account.
                    readOnly: true
                  account_industry:
                    type: string
                    title: Account Industry
                    description: The user-specified industry associated with the account.
                    readOnly: true
                  contact:
                    type: object
                    title: Account Contact
                    description: Information about the account contact.
                    readOnly: true
                    properties:
                      company:
                        type: string
                        title: Company
                        description: The company name for the account.
                        readOnly: true
                      addr1:
                        type: string
                        title: Address Line 1
                        description: The street address for the account contact.
                        readOnly: true
                      addr2:
                        type: string
                        title: Address Line 2
                        description: The street address for the account contact.
                        readOnly: true
                      city:
                        type: string
                        title: City
                        description: The city for the account contact.
                        readOnly: true
                      state:
                        type: string
                        title: State
                        description: The state for the account contact.
                        readOnly: true
                      zip:
                        type: string
                        title: Zip Code
                        description: The zip code for the account contact.
                        readOnly: true
                      country:
                        type: string
                        title: Country
                        description: The country for the account contact.
                        readOnly: true
                  pro_enabled:
                    type: boolean
                    title: Mailchimp Pro
                    description: Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-legacy-pricing-plan/).
                    readOnly: true
                  last_login:
                    type: string
                    title: Last Login Date
                    description: The date and time of the last login for this account in ISO 8601 format.
                    readOnly: true
                    format: date-time
                  total_subscribers:
                    type: integer
                    title: Total Subscribers
                    description: The total number of subscribers across all lists in the account.
                    readOnly: true
                  industry_stats:
                    type: object
                    title: Industry Stats
                    description: The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry.
                    readOnly: true
                    properties:
                      open_rate:
                        type: number
                        title: Open Rate
                        description: The average unique open rate for all campaigns in the account's specified industry.
                        readOnly: true
                      bounce_rate:
                        type: number
                        title: Bounce Rate
                        description: The average bounce rate for all campaigns in the account's specified industry.
                        readOnly: true
                      click_rate:
                        type: number
                        title: Click Rate
                        description: The average unique click rate for all campaigns in the account's specified industry.
                        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
      deprecated: false
      tags:
      - root
      x-custom-config:
        methodNameSnake: get_root
        methodNameCamel: getRoot
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Learn more with the full Mailchimp API documentation.
  url: https://mailchimp.com/developer/marketing/
x-doc-structure:
  resources:
    root:
      title: API Root
      description: The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.
      paths:
      - /
      subResources: []
    chimp-chatter:
      title: Chimp Chatter Activity
      description: Get the latest Chimp Chatter activity from your account.
      paths:
      - /activity-feed/chimp-chatter
    audiences:
      title: Audiences (BETA)
      description: Your Mailchimp audience is where you store and manage all of your omni-channel contacts. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-introduction). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) for terms and additional details.
      paths:
      - /audiences
      - /audiences/{audience_id}
      subResources:
      - audiences-contacts
      - audiences-contact-privacy-remove
    audiences-contacts:
      title: Contacts
      description: Manage contacts within a Mailchimp audience. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-introduction). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) for terms and additional details.
      paths:
      - /audiences/{audience_id}/contacts
      - /audiences/{audience_id}/contacts/{contact_id}
      - /audiences/{audience_id}/contacts/{contact_id}/actions/archive
      - /audiences/{audience_id}/contacts/{contact_id}/actions/forget
      subResources:
      - audiences-contacts-tags
      - audiences-contact-events
    authorized-apps:
      title: Authorized Apps
      description: Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.
      paths:
      - /authorized-apps
      - /authorized-apps/{app_id}
    automation:
      title: Classic Automations
      description: Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage workflows, emails, and queues for Classic Automations. Does not include Automation flows.
      paths:
      - /automations
      - /automations/{workflow_id}
      - /automations/{workflow_id}/actions/start-all-emails
      - /automations/{workflow_id}/actions/pause-all-emails
      - /automations/{workflow_id}/actions/archive
      subResources:
      - automation-email
      - automation-removed-subscribers
    automation-email:
      title: Emails
      description: Manage individual emails in a classic automation workflow.
      paths:
      - /automations/{workflow_id}/emails
      - /automations/{workflow_id}/emails/{workflow_email_id}
      - /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
      - /automations/{workflow_id}/emails/{workflow_email_id}/actions/start
      subResources:
      - automation-email-queue
    automation-email-queue:
      title: Queue
      description: Manage list member queues for classic automation emails.
      paths:
      - /automations/{workflow_id}/emails/{workflow_email_id}/queue
      - /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
      subResources: []
    automation-removed-subscribers:
      title: Removed Subscribers
      description: Remove subscribers from a classic automation workflow.
      paths:
      - /automations/{workflow_id}/removed-subscribers
      - /automations/{workflow_id}/removed-subscribers/{subscriber_hash}
      subResources: []
    batch-operations:
      title: Batch Operations
      description: Use batch operations to complete multiple operations with a single call.
      paths:
      - /batches
      - /batches/{batch_id}
    batch-webhooks:
      title: Batch Webhooks
      description: Manage webhooks for batch operations.
      paths:
      - /batch-webhooks
      - /batch-webhooks/{batch_webhook_id}
    account-exports:
      title: Account Exports
      description: Generate a new account export or download a finished account export.
      paths:
      - /account-exports
      - /account-exports/{export_id}
    campaigns:
      title: Campaigns
      description: Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.
      paths:
      - /campaigns
      - /campaigns/{campaign_id}
      - /campaigns/{campaign_id}/actions/cancel-send
      - /campaigns/{campaign_id}/actions/send
      - /campaigns/{campaign_id}/actions/schedule
      - /campaigns/{campaign_id}/actions/unschedule
      - /campaigns/{campaign_id}/actions/pause
      - /campaigns/{campaign_id}/actions/resume
      - /campaigns/{campaign_id}/actions/replicate
      - /campaigns/{campaign_id}/actions/test
      - /campaigns/{campaign_id}/actions/create-resend
      subResources:
      - campaign-feedback
      - campaign-checklist
      - campaign-content
    sms-campaigns:
      title: SMS Campaigns
      description: SMS Campaigns allow you to send text message marketing campaigns to your Mailchimp audience.
      paths:
      - /sms-campaigns
      - /sms-campaigns/{sms_campaign_id}
      - /sms-campaigns/{sms_campaign_id}/actions/cancel-send
      - /sms-campaigns/{sms_campaign_id}/actions/send
      - /sms-campaigns/{sms_campaign_id}/actions/schedule
      subResources:
      - sms-campaign-content
    sms-campaign-content:
      title: SMS Campaign Content
      description: Manage the content of an SMS campaign.
      paths:
      - /sms-campaigns/{sms_campaign_id}/content
      subResources: []
    campaign-feedback:
      title: Feedback
      description: Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.
      paths:
      - /campaigns/{campaign_id}/feedback
      - /campaigns/{campaign_id}/feedback/{feedback_id}
    campaign-checklist:
      title: Send Checklist
      description: Review the send checklist for your campaign, and resolve any issues before sending.
      paths:
      - /campaigns/{campaign_id}/send-checklist
    campaign-content:
      title: Content
      description: Manage the HTML, plain-text, and template content for your Mailchimp campaigns.
      paths:
      - /campaign

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