Postgrid

Tool to cancel a box order by its ID. Use when you need to cancel a pending box shipment.

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.

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.

Tool to cancel a postcard order. Use when you need to cancel a postcard that has status 'ready'.

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.

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.

Tool to create a new bank account for print & mail service.

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.

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.

Tool to create a new contact in PostGrid. Use after collecting contact's name, address, and optional metadata.

Tool to create and send a letter via PostGrid. Use when recipient, sender, and content details are ready.

Tool to create and send a postcard via PostGrid. Use when recipient, sender, and content (HTML, template, or PDF) are ready.

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.

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).

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.

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.

Tool to create a tracker for monitoring mail delivery status via URL tracking. Use when you need to track recipient engagement with personalized URLs.

Tool to create a new webhook to receive order event notifications. Use after configuring your endpoint to handle webhook payloads.

Tool to delete a bank account by its ID. Use when you need to remove a bank account after confirming its identifier.

Tool to delete a contact by its ID. Use when you need to remove obsolete contacts after confirming their identifier.

Tool to delete a template by its ID. Use when you need to remove an existing template after confirming its identifier.

Tool to delete a template editor session by its ID. Use when you need to remove an existing template editor session.

Tool to delete a tracker by its ID. Use when you need to remove an existing tracker after confirming its identifier.

Tool to delete a webhook subscription. Use when you need to remove an existing webhook by its ID.

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.

Tool to retrieve a bank account. Use after obtaining the bank account ID to fetch its details.

Tool to retrieve a specific box order by ID. Use after obtaining the box ID to fetch its details.

Tool to retrieve a specific cheque by ID. Use when you need to fetch details of a specific cheque order.

Tool to retrieve a contact. Use after obtaining the contact ID to fetch its details.

Tool to retrieve a letter. Use after you have the letter ID to fetch its details.

Tool to retrieve a specific postcard by ID. Use when you have a postcard ID and need to fetch its details.

Tool to retrieve a return envelope. Use after obtaining the return envelope ID to fetch its details.

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.

Tool to retrieve a template. Use when you have the template ID and need its details.

Tool to retrieve a tracker. Use when you have the tracker ID and need its details.

Tool to retrieve details of a specific webhook by its ID. Use after creating a webhook to fetch its configuration and status.

Tool to list bank accounts. Use when retrieving bank accounts with optional status filter and pagination.

Tool to list box orders. Use when you need to retrieve a paginated list of box orders from PostGrid.

Tool to list cheques with optional filters and pagination. Use when you need to retrieve batches of cheque records for processing or reporting.

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.

Tool to retrieve a list of webhook events with optional pagination. Use when you need to view all webhook events that have occurred.

Tool to list letters. Use when retrieving letters with optional filters and pagination.

Tool to list all postal statements for billing and tracking purposes. Use when you need to retrieve statements for accounting or audit purposes.

Tool to retrieve a list of postcards with optional filtering and pagination. Use when you need to browse or filter postcards list.

Tool to list all return envelope orders for a specific return envelope. Use when retrieving orders associated with a return envelope ID.

Tool to list return envelopes. Use when you need to retrieve a paginated list of business reply envelopes (BREs) with optional pagination.

Tool to list self-mailers. Use when you need to fetch self-mailers with filters and pagination.

Tool to list sub-organizations. Use when you need to retrieve a paginated list of sub-organizations with optional search filter.

Tool to list template editor sessions. Use when you need to retrieve a paginated list of template editor sessions.

Tool to list templates. Use when you need to retrieve a paginated list of templates with optional type filtering.

Tool to list all trackers. Use when you need to retrieve a paginated list of trackers for tracking mail interactions.

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.

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.

Tool to retrieve a list of configured webhooks with optional filtering and pagination. Use when you need to view your webhooks.

Tool to progress a test box through processing stages for webhook testing. Use when testing webhook integration by advancing box status.

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.

Tool to progress a test postcard through processing stages for webhook testing. Use when testing webhook integration by advancing postcard status.

Tool to update an existing mail template in PostGrid. Use when you need to modify the HTML content, description, or metadata of a template.

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.

Tool to update an existing webhook configuration. Use when you need to modify webhook URL, events, or other settings.