Mailchimp Batches API

openapi: 3.2.0
info:
  version: 3.0.91
  title: Mailchimp Marketing Batches 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: batches
paths:
  /batches:
    get:
      summary: List batch requests
      description: Get a summary of batch requests that have been made.
      operationId: getBatches
      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
      - 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: ''
          content:
            application/json:
              schema:
                type: object
                title: Batch Operations
                description: A summary of batch requests that have been made.
                properties:
                  batches:
                    type: array
                    items:
                      type: object
                      title: Batch
                      description: The status of a batch request
                      properties:
                        id:
                          type: string
                          title: Batch ID
                          description: A string that uniquely identifies this batch request.
                          readOnly: true
                        status:
                          type: string
                          title: Status
                          description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status.
                          enum:
                          - pending
                          - preprocessing
                          - started
                          - finalizing
                          - finished
                          readOnly: true
                        total_operations:
                          type: integer
                          title: Total Operations
                          description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
                          readOnly: true
                        finished_operations:
                          type: integer
                          title: Finished Operations
                          description: The number of completed operations. This includes operations that returned an error.
                          readOnly: true
                        errored_operations:
                          type: integer
                          title: Error Operations
                          description: The number of completed operations that returned an error.
                          readOnly: true
                        submitted_at:
                          type: string
                          format: date-time
                          title: Submitted At
                          description: The date and time when the server received the batch request in ISO 8601 format.
                          readOnly: true
                        completed_at:
                          type: string
                          format: date-time
                          title: Completed At
                          description: The date and time when all operations in the batch request completed in ISO 8601 format.
                          readOnly: true
                        response_body_url:
                          type: string
                          title: Response Body URL
                          description: The URL of the gzipped archive of the results of all the operations.
                          readOnly: true
                        _links:
                          title: Links
                          description: A list of link types and descriptions for the API schema documents.
                          type: array
                          items:
                            type: object
                            title: Resource Link
                            description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                            properties:
                              rel:
                                type: string
                                title: Rel
                                description: As with an HTML 'rel' attribute, this describes the type of link.
                                readOnly: true
                              href:
                                type: string
                                title: Href
                                description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                                readOnly: true
                              method:
                                type: string
                                title: Method
                                description: The HTTP method that should be used when accessing the URL defined in 'href'.
                                enum:
                                - GET
                                - POST
                                - PUT
                                - PATCH
                                - DELETE
                                - OPTIONS
                                - HEAD
                                readOnly: true
                              targetSchema:
                                type: string
                                title: Target Schema
                                description: For GETs, this is a URL representing the schema that the response should conform to.
                                readOnly: true
                              schema:
                                type: string
                                title: Schema
                                description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                                readOnly: true
                          readOnly: true
                    title: Batches
                    description: An array of objects representing batch calls.
                  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
                title: Batch Operations
                description: A summary of batch requests that have been made.
                properties:
                  batches:
                    type: array
                    items:
                      type: object
                      title: Batch
                      description: The status of a batch request
                      properties:
                        id:
                          type: string
                          title: Batch ID
                          description: A string that uniquely identifies this batch request.
                          readOnly: true
                        status:
                          type: string
                          title: Status
                          description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status.
                          enum:
                          - pending
                          - preprocessing
                          - started
                          - finalizing
                          - finished
                          readOnly: true
                        total_operations:
                          type: integer
                          title: Total Operations
                          description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
                          readOnly: true
                        finished_operations:
                          type: integer
                          title: Finished Operations
                          description: The number of completed operations. This includes operations that returned an error.
                          readOnly: true
                        errored_operations:
                          type: integer
                          title: Error Operations
                          description: The number of completed operations that returned an error.
                          readOnly: true
                        submitted_at:
                          type: string
                          format: date-time
                          title: Submitted At
                          description: The date and time when the server received the batch request in ISO 8601 format.
                          readOnly: true
                        completed_at:
                          type: string
                          format: date-time
                          title: Completed At
                          description: The date and time when all operations in the batch request completed in ISO 8601 format.
                          readOnly: true
                        response_body_url:
                          type: string
                          title: Response Body URL
                          description: The URL of the gzipped archive of the results of all the operations.
                          readOnly: true
                        _links:
                          title: Links
                          description: A list of link types and descriptions for the API schema documents.
                          type: array
                          items:
                            type: object
                            title: Resource Link
                            description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                            properties:
                              rel:
                                type: string
                                title: Rel
                                description: As with an HTML 'rel' attribute, this describes the type of link.
                                readOnly: true
                              href:
                                type: string
                                title: Href
                                description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                                readOnly: true
                              method:
                                type: string
                                title: Method
                                description: The HTTP method that should be used when accessing the URL defined in 'href'.
                                enum:
                                - GET
                                - POST
                                - PUT
                                - PATCH
                                - DELETE
                                - OPTIONS
                                - HEAD
                                readOnly: true
                              targetSchema:
                                type: string
                                title: Target Schema
                                description: For GETs, this is a URL representing the schema that the response should conform to.
                                readOnly: true
                              schema:
                                type: string
                                title: Schema
                                description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                                readOnly: true
                          readOnly: true
                    title: Batches
                    description: An array of objects representing batch calls.
                  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
      deprecated: false
      tags:
      - batches
      x-custom-config:
        methodNameSnake: list
        methodNameCamel: list
    post:
      summary: Start batch operation
      description: Begin processing a batch operations request.
      operationId: postBatches
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                title: Batch
                description: The status of a batch request
                properties:
                  id:
                    type: string
                    title: Batch ID
                    description: A string that uniquely identifies this batch request.
                    readOnly: true
                  status:
                    type: string
                    title: Status
                    description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status.
                    enum:
                    - pending
                    - preprocessing
                    - started
                    - finalizing
                    - finished
                    readOnly: true
                  total_operations:
                    type: integer
                    title: Total Operations
                    description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
                    readOnly: true
                  finished_operations:
                    type: integer
                    title: Finished Operations
                    description: The number of completed operations. This includes operations that returned an error.
                    readOnly: true
                  errored_operations:
                    type: integer
                    title: Error Operations
                    description: The number of completed operations that returned an error.
                    readOnly: true
                  submitted_at:
                    type: string
                    format: date-time
                    title: Submitted At
                    description: The date and time when the server received the batch request in ISO 8601 format.
                    readOnly: true
                  completed_at:
                    type: string
                    format: date-time
                    title: Completed At
                    description: The date and time when all operations in the batch request completed in ISO 8601 format.
                    readOnly: true
                  response_body_url:
                    type: string
                    title: Response Body URL
                    description: The URL of the gzipped archive of the results of all the operations.
                    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: Batch
                description: The status of a batch request
                properties:
                  id:
                    type: string
                    title: Batch ID
                    description: A string that uniquely identifies this batch request.
                    readOnly: true
                  status:
                    type: string
                    title: Status
                    description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status.
                    enum:
                    - pending
                    - preprocessing
                    - started
                    - finalizing
                    - finished
                    readOnly: true
                  total_operations:
                    type: integer
                    title: Total Operations
                    description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
                    readOnly: true
                  finished_operations:
                    type: integer
                    title: Finished Operations
                    description: The number of completed operations. This includes operations that returned an error.
                    readOnly: true
                  errored_operations:
                    type: integer
                    title: Error Operations
                    description: The number of completed operations that returned an error.
                    readOnly: true
                  submitted_at:
                    type: string
                    format: date-time
                    title: Submitted At
                    description: The date and time when the server received the batch request in ISO 8601 format.
                    readOnly: true
                  completed_at:
                    type: string
                    format: date-time
                    title: Completed At
                    description: The date and time when all operations in the batch request completed in ISO 8601 format.
                    readOnly: true
                  response_body_url:
                    type: string
                    title: Response Body URL
                    description: The URL of the gzipped archive of the results of all the operations.
                    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 represen

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