Create a resource proof
lob_resource_proofs_createGenerate a PDF proof of a postcard, letter, or self-mailer to review layout and content before committing to send. Pass resource parameters exactly as you would for the create endpoint.
Instructions
Create a proof — a PDF preview of how a resource (postcard, letter, self-mailer) will print — for review before committing to a mail send. Pass resource_parameters with the same shape you would pass to the underlying create endpoint (e.g. { front, back, to } for a postcard). Note: the lob_*_preview tools call this endpoint internally; this raw tool is exposed for advanced use cases.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| resource_type | Yes | Type of resource being proofed. | |
| resource_parameters | Yes | Parameters matching the resource type's create shape — e.g. `{ front, back, to }` for a postcard, `{ file, to }` for a letter. Each field accepts an HTML string, URL, or template ID. | |
| template_id | No | Optional template ID to associate with the proof. | |
| extra | No | Additional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource. |