get_batch_status
Check the progress and completion status of an asynchronous batch operation. Poll repeatedly until the status shows as 'finished'.
Instructions
Check the progress and completion status of an asynchronous batch operation.
Use after create_batch to poll for completion. Call repeatedly until status is 'finished'. Do not use for non-batch operations. Use list_batches to see all recent batch operations.
Authenticated via API key. Subject to Mailchimp API rate limits (max 10 concurrent requests). Read-only, safe to retry.
Args: batch_id: The batch operation ID (e.g. 'batch123abc'). Obtain from create_batch.
Returns: JSON with fields: id, status ('pending' = queued, 'started' = in progress, 'finished' = complete), total_operations (int), finished_operations (int), errored_operations (int), submitted_at (ISO 8601), completed_at (ISO 8601 or null), response_body_url (string, downloadable tar.gz archive with per-operation results, only available when status is 'finished').
Example: get_batch_status(batch_id="batch123") -> {"status": "finished", "total_operations": 100, "finished_operations": 100, "errored_operations": 2, "response_body_url": "https://...", ...}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |