postgrid_create_letter
Send physical letters through PostGrid, selecting First Class, Certified, or Certified with Return Receipt. Preview the mailing details before confirming to trigger the actual send.
Instructions
Send a physical letter via PostGrid. Supports standard First Class, Certified Mail, and Certified Mail with Return Receipt. Call without confirmed=true to preview the send details; call with confirmed=true to actually send.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Recipient: contact ID (e.g., 'contact_xxx') or inline object as JSON string | |
| from | Yes | Sender: contact ID or inline object as JSON string | |
| html | No | Letter content as HTML (use this OR template OR uploadedPDF) | |
| color | No | Print in color (default: false) | |
| sendDate | No | Scheduled send date in YYYY-MM-DD format | |
| template | No | Template ID to use for letter content | |
| confirmed | No | Set to true to confirm and send. Without this, only a preview is returned. | |
| description | No | Internal description | |
| doubleSided | No | Print double-sided (default: false) | |
| uploadedPDF | No | URL of a PDF to use as letter content | |
| envelopeType | No | Envelope type (e.g., 'standard_window', 'standard_double_window') | |
| mailingClass | No | Mailing class: 'first_class' (default), 'standard_class', 'certified', 'certified_return_receipt' | |
| mergeVariables | No | Template merge variables as key-value pairs | |
| addressPlacement | No | Where to print the address: 'top_first_page' (overlays address on page 1) or 'insert_blank_page' (adds a separate address page, preserving your content). Automatically defaults to 'insert_blank_page' when uploadedPDF is provided, since PDFs are pre-formatted and the overlay would cover existing content. Defaults to 'top_first_page' for HTML/template content. |