get_batch_mail
Retrieve a mail batch's status, recipient summary, pricing, links, and first 50 pieces by batch ID. Poll it after confirming a batch to track progress or handle failures.
Instructions
A batch with its status (draft → paid → generating → submitted → in_progress → completed | partially_completed | failed; cancelled), recipient summary, pricing (credits_charged, refunded_cents), links and the first 50 pieces. Poll it after confirm; batch.submitted / batch.completed also arrive on the agent's webhook.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | The batch's id (UUID) from create_batch_mail or list_batch_mail. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | batch and pieces (first 50 in mailing order). |