create_test_outbound_mail
Create a simulated outbound mail record to rehearse workflows, estimate costs, and trigger webhooks without sending real mail or incurring charges.
Instructions
Create a sandbox outbound mail record without uploading a real document. The record is always test_mode=true, cost_cents=0, includes estimated_live_cost_cents and cost_breakdown, and queues a mail.submitted webhook. Use with a sandbox key to rehearse outbound workflows before sending real physical mail.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| color | No | Whether to include color-print surcharge in the live estimate. | |
| metadata | No | Arbitrary metadata echoed in responses and webhooks. | |
| mail_class | No | Mail class to simulate. | first_class |
| page_count | No | Simulated page count used for pricing. | |
| agent_notes | No | Optional facility/operator notes for the simulated mailpiece. | |
| recipient_zip | No | Recipient ZIP code. Affects estimated live postage. | 94105 |
| recipient_city | No | Recipient city. | San Francisco |
| recipient_name | No | Recipient name for the simulated mailpiece. | Test Recipient |
| recipient_line1 | No | Recipient street line 1. | 123 Test Street |
| recipient_state | No | Recipient 2-letter state code. | CA |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Created sandbox outbound mail job and webhook status. |