> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Postgrid

> PostGrid provides APIs for automating direct mail and address verification services, enabling businesses to send letters, postcards, and checks, as well as verify and standardize addresses in real-time.

![Postgrid logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/postgrid.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=92a8d6a7aa7f97baee6a65c520f121d0)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 60
* **Triggers:** 0
* **Slug:** `POSTGRID`
* **Version:** 20261101\_00

## Tools

> [accordion] Cancel Box
>
> **Slug:** `POSTGRID_CANCEL_BOX`
>
> Tool to cancel a box order by its ID. Use when you need to cancel a pending box shipment.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the box to cancel (format: box\_XXXX)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Cheque
>
> **Slug:** `POSTGRID_CANCEL_CHEQUE`
>
> Tool to cancel a cheque order by its ID. Only works when the cheque has 'ready' status. Use when you need to cancel a pending cheque before it is mailed.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the cheque to cancel (starts with cheque\_). The cheque must have 'ready' status to be cancelled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Cheque with Note
>
> **Slug:** `POSTGRID_CANCEL_CHEQUE_WITH_NOTE`
>
> Tool to cancel a cheque order with a cancellation note. Use when you need to cancel a cheque and provide a reason for the cancellation.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the cheque to cancel (format: cheque\_\*)
>
> **note** `string` *required*
>
> Cancellation note explaining the reason for cancellation. Must not be empty.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Postcard
>
> **Slug:** `POSTGRID_CANCEL_POSTCARD`
>
> Tool to cancel a postcard order. Use when you need to cancel a postcard that has status 'ready'.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the postcard to cancel. Only postcards with status 'ready' can be cancelled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Postcard With Note
>
> **Slug:** `POSTGRID_CANCEL_POSTCARD_WITH_NOTE`
>
> Cancel a ready postcard order with a required cancellation note. The response may include cancellation details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The postcard ID to cancel. The postcard must be in 'ready' status to be cancelled.
>
> **note** `string` *required*
>
> Cancellation note explaining why the postcard is being cancelled. This field is required and must not be empty.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Return Envelope Order
>
> **Slug:** `POSTGRID_CANCEL_RETURN_ENVELOPE_ORDER`
>
> Tool to cancel a return envelope order. Use when you need to cancel a pending return envelope order using the return envelope ID and order ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the return envelope
>
> **orderId** `string` *required*
>
> Unique identifier of the return envelope order to cancel
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] CREATE\_BANK\_ACCOUNT
>
> **Slug:** `POSTGRID_CREATE_BANK_ACCOUNT`
>
> Tool to create a new bank account for print & mail service.
>
> #### Input Parameters
>
> **bankName** `string` *required*
>
> Name of the bank
>
> **accountType** `string ("checking" | "savings")` *required*
>
> Type of bank account
>
> **contactEmail** `string` *required*
>
> Contact email for the account
>
> **contactPhone** `string`
>
> Contact phone number
>
> **accountNumber** `string` *required*
>
> Bank account number
>
> **routingNumber** `string` *required*
>
> 9-digit bank routing number
>
> **signatureText** `string`
>
> Signature text
>
> **signatureImage** `string`
>
> URL or file path for signature image
>
> **bankCountryCode** `string` *required*
>
> Country code (ISO 3166-1 alpha-2)
>
> **accountHolderName** `string` *required*
>
> Name of the bank account holder
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Box
>
> **Slug:** `POSTGRID_CREATE_BOX`
>
> Create a box mailing order containing one or more cheques for a sender and recipient.
>
> #### Input Parameters
>
> **to** `string` *required*
>
> Contact ID (e.g., 'contact\_xxx') or inline contact object for the recipient
>
> **from** `string` *required*
>
> Contact ID (e.g., 'contact\_xxx') or inline contact object for the sender
>
> **cheques** `array` *required*
>
> Array of cheque objects to be included in the box (minimum 1, maximum 500). Each cheque must include to, from, bankAccount, amount, and number fields.
>
> **mailingClass** `string`
>
> Mailing class for delivery (e.g., 'first\_class'). Defaults to first\_class.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Cheque
>
> **Slug:** `POSTGRID_CREATE_CHEQUE`
>
> Tool to create a cheque order for physical cheque mailing. Use when you need to send a payment via printed cheque. Requires a valid bank account ID and recipient contact details.
>
> #### Input Parameters
>
> **to** `object` *required*
>
> Recipient contact details (payee)
>
> **memo** `string`
>
> Memo line on the cheque
>
> **amount** `integer` *required*
>
> Cheque amount in cents. For example, 5000 = \$50.00
>
> **number** `integer`
>
> Custom cheque number. If not provided, will auto-increment.
>
> **message** `string`
>
> HTML message to include above the cheque (max 7 inches from top of page)
>
> **metadata** `object`
>
> Custom key-value pairs for metadata
>
> **sendDate** `string`
>
> Scheduled send date in ISO 8601 format
>
> **bankAccount** `string` *required*
>
> Bank account ID for the cheque. Must be created via bank\_accounts endpoint first.
>
> **fromAddress** `object` *required*
>
> Sender contact details (payer)
>
> **extraService** `string`
>
> Extra service option: 'certified' or 'certified\_return\_receipt'
>
> **mailingClass** `string`
>
> Mailing class for delivery (e.g., 'first\_class', 'standard')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact
>
> **Slug:** `POSTGRID_CREATE_CONTACT`
>
> Tool to create a new contact in PostGrid. Use after collecting contact's name, address, and optional metadata.
>
> #### Input Parameters
>
> **city** `string` *required*
>
> City name
>
> **email** `string`
>
> Email address
>
> **lastName** `string` *required*
>
> Last name of the contact
>
> **metadata** `object`
>
> Custom metadata as key-value pairs
>
> **firstName** `string` *required*
>
> First name of the contact
>
> **countryCode** `string` *required*
>
> Country ISO code
>
> **phoneNumber** `string`
>
> Phone number in E.164 format
>
> **postalOrZip** `string` *required*
>
> Postal or ZIP code
>
> **addressLine1** `string` *required*
>
> Street address line 1
>
> **addressLine2** `string`
>
> Street address line 2
>
> **organization** `string`
>
> Organization name
>
> **provinceOrState** `string` *required*
>
> Province or state
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Letter
>
> **Slug:** `POSTGRID_CREATE_LETTER`
>
> Tool to create and send a letter via PostGrid. Use when recipient, sender, and content details are ready.
>
> #### Input Parameters
>
> **to** `object` *required*
>
> Recipient's address details
>
> **pdf** `string`
>
> URL to a PDF file for the letter content. Required if html is not provided
>
> **html** `string`
>
> HTML content of the letter. Required if pdf is not provided
>
> **express** `boolean`
>
> Request express shipping
>
> **metadata** `object`
>
> Custom metadata associated with the letter
>
> **description** `string`
>
> Description of the letter
>
> **fromAddress** `object` *required*
>
> Sender's address details
>
> **mergeVariables** `object`
>
> Key-value pairs for merging data into the letter content
>
> **perforatedPage** `integer`
>
> Page number to be perforated
>
> **returnEnvelope** `string`
>
> Return envelope ID to include with the letter (e.g., 'return\_envelope\_...'). Pass 'true' to use the default return envelope.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Postcard
>
> **Slug:** `POSTGRID_CREATE_POSTCARD`
>
> Tool to create and send a postcard via PostGrid. Use when recipient, sender, and content (HTML, template, or PDF) are ready.
>
> #### Input Parameters
>
> **to** `object` *required*
>
> Recipient's address details
>
> **pdf** `string`
>
> URL or file for a 2-page PDF (front and back). Required if HTML/template options are not provided
>
> **from** `object` *required*
>
> Sender's address details
>
> **size** `string ("6x4" | "9x6" | "11x6")`
>
> Supported postcard sizes.
>
> **backHTML** `string`
>
> HTML content for the back of the postcard. Required if backTemplate and pdf are not provided
>
> **metadata** `object`
>
> Custom metadata associated with the postcard
>
> **sendDate** `string`
>
> Scheduled send date in ISO8601 format
>
> **frontHTML** `string`
>
> HTML content for the front of the postcard. Required if frontTemplate and pdf are not provided
>
> **backTemplate** `string`
>
> Template ID for the back of the postcard. Required if backHTML and pdf are not provided
>
> **mailingClass** `string`
>
> Mailing class for the postcard delivery
>
> **frontTemplate** `string`
>
> Template ID for the front of the postcard. Required if frontHTML and pdf are not provided
>
> **mergeVariables** `object`
>
> Key-value pairs for merging data into template content
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Return Envelope
>
> **Slug:** `POSTGRID_CREATE_RETURN_ENVELOPE`
>
> Tool to create a return envelope for mail recipients to respond. Use when you need to include a prepaid return envelope for recipients to send back responses.
>
> #### Input Parameters
>
> **to** `object` *required*
>
> Recipient contact information (return address where the envelope will be sent back to)
>
> **description** `string`
>
> Optional description to identify the return envelope
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Return Envelope Order
>
> **Slug:** `POSTGRID_CREATE_RETURN_ENVELOPE_ORDER`
>
> Tool to create a batch order of return envelopes to be printed and delivered. Use when you need to order return envelopes in bulk (minimum 5000 units).
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the return envelope to create an order for
>
> **quantityOrdered** `integer` *required*
>
> The quantity of return envelopes to order. Must be at least 5000.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template
>
> **Slug:** `POSTGRID_CREATE_TEMPLATE`
>
> Tool to create a new mail template in PostGrid. Use when you need to define reusable HTML content with dynamic placeholders. Use after confirming required template details.
>
> #### Input Parameters
>
> **html** `string` *required*
>
> HTML content of the template (supports Handlebars/Mustache syntax)
>
> **name** `string` *required*
>
> Name of the template
>
> **description** `string`
>
> Description of the template
>
> **testRenderModel** `object`
>
> Data model used for testing the template rendering
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template Editor Session
>
> **Slug:** `POSTGRID_CREATE_TEMPLATE_EDITOR_SESSION`
>
> Tool to create a template editor session for interactive template editing. Use when you need to generate an embeddable URL for editing a template. The session URL allows users to modify template HTML content in a visual editor.
>
> #### Input Parameters
>
> **template** `string` *required*
>
> The ID of an existing template to open in the editor session. Must be a valid template ID with format template\_\*
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Tracker
>
> **Slug:** `POSTGRID_CREATE_TRACKER`
>
> Tool to create a tracker for monitoring mail delivery status via URL tracking. Use when you need to track recipient engagement with personalized URLs.
>
> #### Input Parameters
>
> **metadata** `object`
>
> Custom metadata as key-value pairs
>
> **description** `string`
>
> Optional description for the tracker
>
> **urlExpireAfterDays** `integer ("30" | "60" | "90")` *required*
>
> Number of days until generated URLs expire. Must be 30, 60, or 90 days.
>
> **redirectURLTemplate** `string` *required*
>
> The base URL template for personalized redirects. Supports merge variables like \{\{to.firstName}}, \{\{to.lastName}}, \{\{from.city}}, \{\{to.metadata.id}}, etc. Any merge variable available in the order can be accessed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `POSTGRID_CREATE_WEBHOOK`
>
> Tool to create a new webhook to receive order event notifications. Use after configuring your endpoint to handle webhook payloads.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL where webhook payloads will be sent.
>
> **enabledEvents** `array` *required*
>
> List of events that trigger the webhook. Possible values include: 'letter.created', 'letter.updated', 'postcard.created', 'postcard.updated', 'cheque.created', 'cheque.updated', 'self\_mailer.created', 'self\_mailer.updated', 'return\_envelope\_order.created', 'return\_envelope\_order.updated'.
>
> **payloadFormat** `string ("jwt" | "json")`
>
> Format of the webhook payload: 'jwt' (signed) or 'json' (plain JSON). Defaults to 'jwt'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Bank Account
>
> **Slug:** `POSTGRID_DELETE_BANK_ACCOUNT`
>
> Tool to delete a bank account by its ID. Use when you need to remove a bank account after confirming its identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the bank account to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `POSTGRID_DELETE_CONTACT`
>
> Tool to delete a contact by its ID. Use when you need to remove obsolete contacts after confirming their identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the contact to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `POSTGRID_DELETE_TEMPLATE`
>
> Tool to delete a template by its ID. Use when you need to remove an existing template after confirming its identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the template to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template Editor Session
>
> **Slug:** `POSTGRID_DELETE_TEMPLATE_EDITOR_SESSION`
>
> Delete an existing PostGrid template editor session by its ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the template editor session to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Tracker
>
> **Slug:** `POSTGRID_DELETE_TRACKER`
>
> Tool to delete a tracker by its ID. Use when you need to remove an existing tracker after confirming its identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the tracker to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `POSTGRID_DELETE_WEBHOOK`
>
> Tool to delete a webhook subscription. Use when you need to remove an existing webhook by its ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the webhook to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fill Test Return Envelope Order
>
> **Slug:** `POSTGRID_FILL_TEST_RETURN_ENVELOPE_ORDER`
>
> Tool to fill a test return envelope order for testing purposes. This simulates filling a return envelope order in test mode, changing the status from 'placed' to 'filled'. Only works in test mode.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The return envelope ID (prefixed with return\_envelope\_)
>
> **orderId** `string` *required*
>
> The return envelope order ID (prefixed with return\_envelope\_order\_)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bank Account
>
> **Slug:** `POSTGRID_GET_BANK_ACCOUNT`
>
> Tool to retrieve a bank account. Use after obtaining the bank account ID to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the bank account to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Box
>
> **Slug:** `POSTGRID_GET_BOX`
>
> Tool to retrieve a specific box order by ID. Use after obtaining the box ID to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the box to retrieve. Format: box\_\[alphanumeric]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cheque
>
> **Slug:** `POSTGRID_GET_CHEQUE`
>
> Tool to retrieve a specific cheque by ID. Use when you need to fetch details of a specific cheque order.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the cheque to retrieve (starts with 'cheque\_')
>
> **expand** `array`
>
> Array of nested resources to expand (e.g., \['bankAccount', 'template']). When expanded, the response will include full objects instead of just IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact
>
> **Slug:** `POSTGRID_GET_CONTACT`
>
> Tool to retrieve a contact. Use after obtaining the contact ID to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the contact to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Letter
>
> **Slug:** `POSTGRID_GET_LETTER`
>
> Tool to retrieve a letter. Use after you have the letter ID to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the letter to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Postcard
>
> **Slug:** `POSTGRID_GET_POSTCARD`
>
> Tool to retrieve a specific postcard by ID. Use when you have a postcard ID and need to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the postcard to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Return Envelope
>
> **Slug:** `POSTGRID_GET_RETURN_ENVELOPE`
>
> Tool to retrieve a return envelope. Use after obtaining the return envelope ID to fetch its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the return envelope to retrieve, prefixed with 'return\_envelope\_'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Return Envelope Order
>
> **Slug:** `POSTGRID_GET_RETURN_ENVELOPE_ORDER`
>
> Tool to retrieve a specific return envelope order. Use when you need to get details about an order by its return envelope ID and order ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the return envelope
>
> **orderId** `string` *required*
>
> Unique identifier of the return envelope order
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `POSTGRID_GET_TEMPLATE`
>
> Tool to retrieve a template. Use when you have the template ID and need its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the template to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tracker
>
> **Slug:** `POSTGRID_GET_TRACKER`
>
> Tool to retrieve a tracker. Use when you have the tracker ID and need its details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the tracker to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `POSTGRID_GET_WEBHOOK`
>
> Tool to retrieve details of a specific webhook by its ID. Use after creating a webhook to fetch its configuration and status.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the webhook to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bank Accounts
>
> **Slug:** `POSTGRID_LIST_BANK_ACCOUNTS`
>
> List bank accounts with optional pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip for pagination (default 0)
>
> **limit** `integer`
>
> Maximum number of bank accounts to return (default 10, max 100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Box Orders
>
> **Slug:** `POSTGRID_LIST_BOXES`
>
> Tool to list box orders. Use when you need to retrieve a paginated list of box orders from PostGrid.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of box orders to skip for pagination
>
> **limit** `integer`
>
> Maximum number of box orders to return per page (1-100, default 10)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cheques
>
> **Slug:** `POSTGRID_LIST_CHEQUES`
>
> Tool to list cheques with optional filters and pagination. Use when you need to retrieve batches of cheque records for processing or reporting.
>
> #### Input Parameters
>
> **after** `string`
>
> Cursor for pagination. Fetch items after this cursor.
>
> **count** `integer`
>
> Number of items to return per page. Maximum is 100.
>
> **status** `string ("created" | "mailed" | "failed")`
>
> Filter by cheque status.
>
> **to\_date** `string`
>
> ISO-8601 timestamp. Only return cheques created before this time.
>
> **from\_date** `string`
>
> ISO-8601 timestamp. Only return cheques created after this time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contacts
>
> **Slug:** `POSTGRID_LIST_CONTACTS`
>
> List contacts with optional search and pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of contacts to skip for pagination
>
> **limit** `integer`
>
> Maximum number of contacts to return per page (1-100)
>
> **search** `string`
>
> Search query to filter contacts by name, address, email, or other fields
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Events
>
> **Slug:** `POSTGRID_LIST_EVENTS`
>
> Tool to retrieve a list of webhook events with optional pagination. Use when you need to view all webhook events that have occurred.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of events to skip for pagination
>
> **limit** `integer`
>
> Maximum number of events to return per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Letters
>
> **Slug:** `POSTGRID_LIST_LETTERS`
>
> Tool to list letters. Use when retrieving letters with optional filters and pagination.
>
> #### Input Parameters
>
> **after** `string`
>
> Cursor for pagination to fetch records created after a specific ID
>
> **limit** `integer`
>
> Maximum number of records to return (default 10, max 100)
>
> **before** `string`
>
> Cursor for pagination to fetch records created before a specific ID
>
> **dateTo** `string`
>
> Filter letters created on or before this date (ISO 8601)
>
> **status** `string ("draft" | "ready" | "printing" | "processed" | "completed" | "cancelled")`
>
> Filter letters by status (ready, printing, processed, completed, cancelled)
>
> **dateFrom** `string`
>
> Filter letters created on or after this date (ISO 8601)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Postal Statements
>
> **Slug:** `POSTGRID_LIST_POSTAL_STATEMENTS`
>
> Tool to list all postal statements for billing and tracking purposes. Use when you need to retrieve statements for accounting or audit purposes.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of postal statements to skip for pagination
>
> **limit** `integer`
>
> Maximum number of postal statements to return per page (1-100)
>
> **search** `string`
>
> Search query to filter postal statements by various fields
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Postcards
>
> **Slug:** `POSTGRID_LIST_POSTCARDS`
>
> Tool to retrieve a list of postcards with optional filtering and pagination. Use when you need to browse or filter postcards list.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip (offset).
>
> **limit** `integer`
>
> Number of records per page (1-100).
>
> **status** `string ("draft" | "queued" | "processing" | "completed" | "failed")`
>
> Filter by postcard status.
>
> **to\_date** `string`
>
> Return postcards created before this ISO8601 timestamp.
>
> **metadata** `object`
>
> Filter by custom metadata key-value pairs.
>
> **from\_date** `string`
>
> Return postcards created after this ISO8601 timestamp.
>
> **contact\_id** `string`
>
> Filter by the contact's unique ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Return Envelope Orders
>
> **Slug:** `POSTGRID_LIST_RETURN_ENVELOPE_ORDERS`
>
> Tool to list all return envelope orders for a specific return envelope. Use when retrieving orders associated with a return envelope ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The return envelope ID (prefixed with return\_envelope\_)
>
> **skip** `integer`
>
> Number of records to skip for pagination
>
> **limit** `integer`
>
> Maximum number of records to return (default 10, max 100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Return Envelopes
>
> **Slug:** `POSTGRID_LIST_RETURN_ENVELOPES`
>
> Tool to list return envelopes. Use when you need to retrieve a paginated list of business reply envelopes (BREs) with optional pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of return envelopes to skip for pagination
>
> **limit** `integer`
>
> Maximum number of return envelopes to return per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Self-Mailers
>
> **Slug:** `POSTGRID_LIST_SELF_MAILERS`
>
> Tool to list self-mailers. Use when you need to fetch self-mailers with filters and pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip (offset)
>
> **limit** `integer`
>
> Number of records per page (1-100)
>
> **status** `string`
>
> Filter by status (e.g., 'draft', 'queued', 'processing', 'completed', 'failed')
>
> **to\_date** `string`
>
> Filter self-mailers created on or before this ISO 8601 timestamp (inclusive)
>
> **metadata** `object`
>
> Key-value metadata pairs to filter self-mailers
>
> **from\_date** `string`
>
> Filter self-mailers created on or after this ISO 8601 timestamp (inclusive)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sub-Organizations
>
> **Slug:** `POSTGRID_LIST_SUB_ORGANIZATIONS`
>
> Tool to list sub-organizations. Use when you need to retrieve a paginated list of sub-organizations with optional search filter.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip for pagination (default 0)
>
> **limit** `integer`
>
> Maximum number of sub-organizations to return (default 10, max 100)
>
> **search** `string`
>
> Search query to filter sub-organizations by name or other fields
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Template Editor Sessions
>
> **Slug:** `POSTGRID_LIST_TEMPLATE_EDITOR_SESSIONS`
>
> Tool to list template editor sessions. Use when you need to retrieve a paginated list of template editor sessions.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of sessions to skip for pagination
>
> **limit** `integer`
>
> Maximum number of sessions to return per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `POSTGRID_LIST_TEMPLATES`
>
> List mail templates with optional pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of templates to skip for pagination
>
> **limit** `integer`
>
> Maximum number of templates to return per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Trackers
>
> **Slug:** `POSTGRID_LIST_TRACKERS`
>
> Tool to list all trackers. Use when you need to retrieve a paginated list of trackers for tracking mail interactions.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of trackers to skip for pagination (defaults to 0)
>
> **limit** `integer`
>
> Maximum number of trackers to return per page (defaults to 10, max 100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tracker Visits
>
> **Slug:** `POSTGRID_LIST_TRACKER_VISITS`
>
> Tool to list all visits for a tracker. Use when you need to retrieve visit information including device, IP address, and referred tracker/order ID for each visit.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the tracker to retrieve visits for
>
> **skip** `integer`
>
> Number of visits to skip for pagination
>
> **limit** `integer`
>
> Maximum number of visits to return per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Invocations
>
> **Slug:** `POSTGRID_LIST_WEBHOOK_INVOCATIONS`
>
> Tool to list previous invocations of a webhook with response status codes. Use when you need to view the history of webhook delivery attempts and their outcomes.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the webhook to retrieve invocations for.
>
> **skip** `integer`
>
> Number of invocations to skip for pagination (default: 0).
>
> **limit** `integer`
>
> Number of invocations to return (default: 40, max: 100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `POSTGRID_LIST_WEBHOOKS`
>
> Retrieve a paginated list of configured webhooks.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of webhooks to skip for pagination.
>
> **limit** `integer`
>
> Maximum number of webhooks to return per page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Progress Test Box
>
> **Slug:** `POSTGRID_PROGRESS_TEST_BOX`
>
> Tool to progress a test box through processing stages for webhook testing. Use when testing webhook integration by advancing box status.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the test box to progress through stages. Must be a test mode box.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Progress Test Cheque
>
> **Slug:** `POSTGRID_PROGRESS_TEST_CHEQUE`
>
> Tool to progress a test cheque through processing stages for webhook testing. Use when you need to simulate cheque status changes (ready -> printing -> processed\_for\_delivery -> completed) to test webhook integrations.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the test cheque to progress. Must be a test cheque (not a live cheque).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Progress Test Postcard
>
> **Slug:** `POSTGRID_PROGRESS_TEST_POSTCARD`
>
> Tool to progress a test postcard through processing stages for webhook testing. Use when testing webhook integration by advancing postcard status.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the test postcard to progress through stages. Must be a test mode postcard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template
>
> **Slug:** `POSTGRID_UPDATE_TEMPLATE`
>
> Update an existing PostGrid mail template with required HTML content and optional description or metadata.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the template to update. Must start with 'template\_'
>
> **html** `string` *required*
>
> Updated HTML content for the template (supports Handlebars/Mustache syntax)
>
> **metadata** `object`
>
> Custom key-value pairs for organizing and tracking the template
>
> **description** `string`
>
> Updated description for the template
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Tracker
>
> **Slug:** `POSTGRID_UPDATE_TRACKER`
>
> Tool to update an existing tracker's redirect URL template and/or expiration settings. Use when you need to modify tracker configuration after obtaining its identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the tracker to update
>
> **urlExpireAfterDays** `integer`
>
> Number of days before generated URLs expire. Must be 30, 60, or 90
>
> **redirectURLTemplate** `string`
>
> The base URL template for personalized redirects, supporting merge variables like \{\{to.firstName}} and \{\{to.metadata.id}}
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `POSTGRID_UPDATE_WEBHOOK`
>
> Tool to update an existing webhook configuration. Use when you need to modify webhook URL, events, or other settings.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the webhook to update (path parameter).
>
> **url** `string`
>
> The URL where webhook payloads will be sent.
>
> **enabled** `boolean`
>
> Whether the webhook is enabled or disabled.
>
> **enabledEvents** `array`
>
> List of events that trigger the webhook. Possible values include: 'letter.created', 'letter.updated', 'postcard.created', 'postcard.updated', 'cheque.created', 'cheque.updated', 'self\_mailer.created', 'self\_mailer.updated', 'return\_envelope\_order.created', 'return\_envelope\_order.updated'.
>
> **payloadFormat** `string ("jwt" | "json")`
>
> Format of the webhook payload: 'jwt' (signed) or 'json' (plain JSON).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
