cancel_batch_mail
Cancel a mail batch before printing starts (draft, paid, generating, or submitted) to receive a full credit refund; in-progress batches cannot be cancelled.
Instructions
Cancel a batch before the facility starts (draft, paid, generating or submitted); credits are refunded in full. Once the facility is printing (in_progress) it cannot be cancelled.
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 | id, status cancelled, refunded_credits_cents, sandbox. |