Postgrid integration

Cancel Box

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

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

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

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

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

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

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

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

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

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

Create Letter

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

Create Postcard

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