Start batch operation

POST

https://api.mailchimp.com/3.0/batches

Begin processing a batch operations request.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Request

This endpoint expects an object.

operationslist of objectsRequired

An array of objects that describes operations to perform.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

completed_atdatetime or ""OptionalRead-only

The date and time when all operations in the batch request completed in ISO 8601 format.

errored_operationsintegerOptionalRead-only

The number of completed operations that returned an error.

finished_operationsintegerOptionalRead-only

The number of completed operations. This includes operations that returned an error.

idstringOptionalRead-only

A string that uniquely identifies this batch request.

response_body_urlstringOptionalRead-only

The URL of the gzipped archive of the results of all the operations.

statusenumOptionalRead-only

The status of the batch call. Learn more about the batch operation status.

Allowed values:

submitted_atdatetimeOptionalRead-only

The date and time when the server received the batch request in ISO 8601 format.

total_operationsintegerOptionalRead-only

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.