| pdf | Yes | The PDF to mail. Accepts attachment objects ({ download_url, file_id }). Fallbacks: upload_token from postalform.create_pdf_upload, data:application/pdf;base64,..., or a public HTTPS download URL. | |
| color | No | Whether to print in color (default: false). | |
| certified | No | Whether to add proof mail: USPS Certified Mail for US destinations, Canada Post Registered Mail through PostGrid for Canadian destinations, or PinGen registered mail for supported European destinations (default: false). | |
| file_name | No | Optional display file name. | |
| buyer_name | No | Receipt name; defaults to sender_name for MPP. | |
| mail_class | No | Mail service level (standard, priority, express). | |
| request_id | No | Optional idempotency key. Reuse the same value if retrying the call. | |
| buyer_email | No | Required for MPP receipt delivery. | |
| sender_name | Yes | Sender's name (return address). | |
| double_sided | No | Whether to print double-sided (default: true). | |
| recipient_name | Yes | Recipient's name. | |
| payment_protocol | No | Optional payment path. Defaults to hosted checkout. Choose mpp to return a payment challenge for this same prepared order; buyer_email is required. Draft creation never pays. | |
| sender_address_id | No | Loqate address id for the sender (required when sender_address_type is Address). | |
| sender_address_text | No | Human-readable sender address preview (required when sender_address_type is Address; optional for Manual). | |
| sender_address_type | Yes | Address suggestion type for the sender (from postalform.search_addresses). Use Manual to pass a structured address with countryCode when outside the US. | |
| recipient_address_id | No | Loqate address id for the recipient (required when recipient_address_type is Address). | |
| sender_address_manual | No | Sender manual address fields (required when sender_address_type is Manual). | |
| recipient_address_text | No | Human-readable recipient address preview (required when recipient_address_type is Address; optional for Manual). | |
| recipient_address_type | Yes | Address suggestion type for the recipient (from postalform.search_addresses). Use Manual to pass a structured address with countryCode when outside the US. | |
| certified_return_receipt | No | Add Electronic Return Receipt for US Certified Mail. Ignored for Canada Post Registered Mail and PinGen registered-mail destinations (default: false). | |
| recipient_address_manual | No | Recipient manual address fields (required when recipient_address_type is Manual). | |