# 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. - **Category:** developer tools - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 60 - **Triggers:** 0 - **Slug:** `POSTGRID` - **Version:** 20260506_00 ## Tools ### 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. ### 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. ### 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. ### Cancel Postcard **Slug:** `POSTGRID_CANCEL_POSTCARD` Tool to cancel a postcard order. Use when you need to cancel a postcard that has status 'ready'. ### Cancel Postcard With Note **Slug:** `POSTGRID_CANCEL_POSTCARD_WITH_NOTE` Tool to cancel a postcard order with an optional cancellation note. Use when you need to cancel a postcard that is in 'ready' status. Once cancelled, the status changes to 'cancelled' and the response includes cancellation details. ### 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. ### CREATE_BANK_ACCOUNT **Slug:** `POSTGRID_CREATE_BANK_ACCOUNT` Tool to create a new bank account for print & mail service. ### Create Box **Slug:** `POSTGRID_CREATE_BOX` Tool to create a box mailing order for letters with plastic cards or cheques. Use when you need to send multiple cheques in a secure box. ### 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. ### Create Contact **Slug:** `POSTGRID_CREATE_CONTACT` Tool to create a new contact in PostGrid. Use after collecting contact's name, address, and optional metadata. ### Create Letter **Slug:** `POSTGRID_CREATE_LETTER` Tool to create and send a letter via PostGrid. Use when recipient, sender, and content details are ready. ### 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. ### 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. ### 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). ### 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. ### 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. ### 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. ### 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. ### 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. ### 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. ### 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. ### Delete Template Editor Session **Slug:** `POSTGRID_DELETE_TEMPLATE_EDITOR_SESSION` Tool to delete a template editor session by its ID. Use when you need to remove an existing template editor session. ### 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. ### Delete Webhook **Slug:** `POSTGRID_DELETE_WEBHOOK` Tool to delete a webhook subscription. Use when you need to remove an existing webhook by its ID. ### 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. ### 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. ### 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. ### 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. ### Get Contact **Slug:** `POSTGRID_GET_CONTACT` Tool to retrieve a contact. Use after obtaining the contact ID to fetch its details. ### Get Letter **Slug:** `POSTGRID_GET_LETTER` Tool to retrieve a letter. Use after you have the letter ID to fetch its details. ### 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. ### 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. ### 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. ### Get Template **Slug:** `POSTGRID_GET_TEMPLATE` Tool to retrieve a template. Use when you have the template ID and need its details. ### Get Tracker **Slug:** `POSTGRID_GET_TRACKER` Tool to retrieve a tracker. Use when you have the tracker ID and need its details. ### 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. ### List Bank Accounts **Slug:** `POSTGRID_LIST_BANK_ACCOUNTS` Tool to list bank accounts. Use when retrieving bank accounts with optional status filter and pagination. ### 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. ### 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. ### List Contacts **Slug:** `POSTGRID_LIST_CONTACTS` Tool to list contacts. Use when you need to retrieve a paginated list of contacts with optional filters like date range, metadata, name, or email. ### 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. ### List Letters **Slug:** `POSTGRID_LIST_LETTERS` Tool to list letters. Use when retrieving letters with optional filters and pagination. ### 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. ### 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. ### 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. ### 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. ### 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. ### 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. ### 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. ### List Templates **Slug:** `POSTGRID_LIST_TEMPLATES` Tool to list templates. Use when you need to retrieve a paginated list of templates with optional type filtering. ### 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. ### 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. ### 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. ### List Webhooks **Slug:** `POSTGRID_LIST_WEBHOOKS` Tool to retrieve a list of configured webhooks with optional filtering and pagination. Use when you need to view your webhooks. ### 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. ### 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. ### 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. ### Update Template **Slug:** `POSTGRID_UPDATE_TEMPLATE` Tool to update an existing mail template in PostGrid. Use when you need to modify the HTML content, description, or metadata of a template. ### 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. ### 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.