Mailchimp Domains API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Domains 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: Domains
paths:
  /reports/{campaign_id}/domain-performance:
    get:
      summary: Mailchimp List Domain Performance Stats
      description: Get statistics for the top-performing email domains in a campaign.
      operationId: getReportsIdDomainPerformance
      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: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Domain Performance
            description: Statistics for the top-performing email domains in a campaign.
            properties:
              domains:
                type: array
                items:
                  type: object
                  title: Email Domain
                  description: A single email domain's performance
                  properties:
                    domain:
                      type: string
                      title: Domain
                      description: The name of the domain (gmail.com, hotmail.com, yahoo.com).
                      readOnly: true
                    emails_sent:
                      type: integer
                      title: Total Sent
                      description: The number of emails sent to that specific domain.
                      readOnly: true
                    bounces:
                      type: integer
                      title: Bounces
                      description: The number of bounces at a domain.
                      readOnly: true
                    opens:
                      type: integer
                      title: Opens
                      description: The number of opens for a domain.
                      readOnly: true
                    clicks:
                      type: integer
                      title: Clicks
                      description: The number of clicks for a domain.
                      readOnly: true
                    unsubs:
                      type: integer
                      title: Unsubscribes
                      description: The total number of unsubscribes for a domain.
                      readOnly: true
                    delivered:
                      type: integer
                      title: Successful Deliveries
                      description: The number of successful deliveries for a domain.
                      readOnly: true
                    emails_pct:
                      type: number
                      title: Email Percent
                      description: The percentage of total emails that went to this domain.
                      readOnly: true
                    bounces_pct:
                      type: number
                      title: Bounces Percent
                      description: The percentage of total bounces from this domain.
                      readOnly: true
                    opens_pct:
                      type: number
                      title: Opens Percent
                      description: The percentage of total opens from this domain.
                      readOnly: true
                    clicks_pct:
                      type: number
                      title: Clicks Percent
                      description: The percentage of total clicks from this domain.
                      readOnly: true
                    unsubs_pct:
                      type: number
                      title: Unsubscribes Percent
                      description: The percentage of total unsubscribes from this domain.
                      readOnly: true
                title: Lists
                description: The top 5 email domains based on total delivered emails.
                readOnly: true
              total_sent:
                type: integer
                title: Total Sent
                description: The total number of emails sent for the campaign.
                readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique id for the campaign.
                readOnly: true
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: get_domain_performance_for_campaign
        methodNameCamel: getDomainPerformanceForCampaign
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /verified-domains/{domain_name}:
    get:
      summary: Mailchimp Get Domain Info
      description: Get the details for a single domain on the account.
      operationId: getVerifiedDomain
      parameters:
      - in: path
        name: domain_name
        x-title: Domain Name
        type: string
        required: true
        description: The domain name.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Verified Domains
            description: The verified domains currently on the account.
            properties:
              domain:
                type: string
                title: Domain Name
                description: The name of this domain.
                readOnly: true
              verified:
                type: boolean
                title: Verified
                description: Whether the domain has been verified for sending.
                readOnly: true
              authenticated:
                type: boolean
                title: Authenticated
                description: Whether domain authentication is enabled for this domain.
                readOnly: true
              verification_email:
                type: string
                title: Verification Email
                description: The e-mail address receiving the two-factor challenge for this domain.
                readOnly: true
              verification_sent:
                type: string
                format: date-time
                title: Verification Challenge Sent
                description: The date/time that the two-factor challenge was sent to the verification email.
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: get_domain
        methodNameCamel: getDomain
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Mailchimp Delete Domain
      description: Delete a verified domain from the account.
      operationId: deleteVerifiedDomain
      parameters:
      - in: path
        name: domain_name
        x-title: Domain Name
        type: string
        required: true
        description: The domain name.
        example: example_value
      responses:
        '204':
          description: Empty Response
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: delete_domain
        methodNameCamel: deleteDomain
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /verified-domains/{domain_name}/actions/verify:
    post:
      summary: Mailchimp Verify Domain
      description: Verify a domain for sending.
      operationId: verifyDomain
      parameters:
      - in: path
        name: domain_name
        x-title: Domain Name
        type: string
        required: true
        description: The domain name.
        example: example_value
      - in: body
        name: body
        description: ''
        required: true
        schema:
          type: object
          title: Verify a domain for sending.
          description: Submit a response to the verification challenge and verify a domain for sending.
          required:
          - code
          properties:
            code:
              type: string
              title: Verification Code
              description: The code that was sent to the email address provided when adding a new domain to verify.
        example: example_value
      responses:
        '200':
          description: The domain being verified for sending.
          schema:
            type: object
            title: Verified Domains
            description: The verified domains currently on the account.
            properties:
              domain:
                type: string
                title: Domain Name
                description: The name of this domain.
                readOnly: true
              verified:
                type: boolean
                title: Verified
                description: Whether the domain has been verified for sending.
                readOnly: true
              authenticated:
                type: boolean
                title: Authenticated
                description: Whether domain authentication is enabled for this domain.
                readOnly: true
              verification_email:
                type: string
                title: Verification Email
                description: The e-mail address receiving the two-factor challenge for this domain.
                readOnly: true
              verification_sent:
                type: string
                format: date-time
                title: Verification Challenge Sent
                description: The date/time that the two-factor challenge was sent to the verification email.
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: submit_domain_verification
        methodNameCamel: submitDomainVerification
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /verified-domains:
    get:
      summary: Mailchimp List Sending Domains
      description: Get all of the sending domains on the account.
      operationId: getVerifiedDomains
      responses:
        '200':
          description: The domains on the account.
          schema:
            type: object
            title: Verified Domains
            description: The verified domains currently on the account.
            properties:
              domains:
                type: array
                title: Domains
                description: The domains on the account
                readOnly: true
                items:
                  type: object
                  title: Verified Domains
                  description: The verified domains currently on the account.
                  properties:
                    domain:
                      type: string
                      title: Domain Name
                      description: The name of this domain.
                      readOnly: true
                    verified:
                      type: boolean
                      title: Verified
                      description: Whether the domain has been verified for sending.
                      readOnly: true
                    authenticated:
                      type: boolean
                      title: Authenticated
                      description: Whether domain authentication is enabled for this domain.
                      readOnly: true
                    verification_email:
                      type: string
                      title: Verification Email
                      description: The e-mail address receiving the two-factor challenge for this domain.
                      readOnly: true
                    verification_sent:
                      type: string
                      format: date-time
                      title: Verification Challenge Sent
                      description: The date/time that the two-factor challenge was sent to the verification email.
                      readOnly: true
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: get_verified_domains_all
        methodNameCamel: getVerifiedDomainsAll
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Domain to Account
      description: Add a domain to the account.
      operationId: createVerifiedDomain
      parameters:
      - in: body
        name: body
        description: ''
        required: true
        schema:
          type: object
          title: Verified Domains
          description: The verified domains currently on the account.
          required:
          - verification_email
          properties:
            verification_email:
              type: string
              title: Verification Email
              description: The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action.
        example: example_value
      responses:
        '200':
          description: The newly-created domain.
          schema:
            type: object
            title: Verified Domains
            description: The verified domains currently on the account.
            properties:
              domain:
                type: string
                title: Domain Name
                description: The name of this domain.
                readOnly: true
              verified:
                type: boolean
                title: Verified
                description: Whether the domain has been verified for sending.
                readOnly: true
              authenticated:
                type: boolean
                title: Authenticated
                description: Whether domain authentication is enabled for this domain.
                readOnly: true
              verification_email:
                type: string
                title: Verification Email
                description: The e-mail address receiving the two-factor challenge for this domain.
                readOnly: true
              verification_sent:
                type: string
                format: date-time
                title: Verification Challenge Sent
                description: The date/time that the two-factor challenge was sent to the verification email.
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Domains
      x-custom-config:
        methodNameSnake: create_verified_domain
        methodNameCamel: createVerifiedDomain
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
securityDefinitions:
  basicAuth:
    type: 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
    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: 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 Automation workflows, emails, and queues. Does not include Customer Journeys.
      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
      descri

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