get_batch_mail_proof
Generates a one-hour, key-free proof link to a PDF of the mail template with the recipient's address label and return address, so a reviewer can verify a batch before confirming it.
Instructions
A proof for the person checking the batch: a one-hour link to a PDF of the template, then the address label the facility applies for one recipient at its real size, next to the return address. Also returns the label's lines as text. Call it after create_batch_mail and give the person proof_url before confirm_batch_mail: it opens in any browser or IDE for an hour, with no key. (links.proof on the batch is the API route itself and needs the API key.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | The batch's id (UUID) from create_batch_mail or list_batch_mail. | |
| recipient | No | Which valid recipient to proof, 1-based. Default 1. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | proof_url (signed, one hour), expires_in, recipient, of, label (lines), page_count. |