- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 60
- Triggers: 0
- Slug:
POSTGRID - Version: 20261101_00
Tools
Cancel Box
Cancel Box
Cancel Cheque
Cancel Cheque
POSTGRID_CANCEL_CHEQUETool 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
Output
Cancel Cheque with Note
Cancel Cheque with Note
Cancel Postcard
Cancel Postcard
Cancel Postcard With Note
Cancel Postcard With Note
Cancel Return Envelope Order
Cancel Return Envelope Order
CREATE_BANK_ACCOUNT
CREATE_BANK_ACCOUNT
Create Box
Create Box
Create Cheque
Create Cheque
Create Contact
Create Contact
Create Letter
Create Letter
Create Postcard
Create Postcard
POSTGRID_CREATE_POSTCARDTool to create and send a postcard via PostGrid. Use when recipient, sender, and content (HTML, template, or PDF) are ready.Input Parameters
Output
Create Return Envelope
Create Return Envelope
POSTGRID_CREATE_RETURN_ENVELOPETool 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
Output
Create Return Envelope Order
Create Return Envelope Order
Create Template
Create Template
Create Template Editor Session
Create Template Editor Session
POSTGRID_CREATE_TEMPLATE_EDITOR_SESSIONTool 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
Output
Create Tracker
Create Tracker
POSTGRID_CREATE_TRACKERTool 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
Output
Create Webhook
Create Webhook
POSTGRID_CREATE_WEBHOOKTool to create a new webhook to receive order event notifications. Use after configuring your endpoint to handle webhook payloads.Input Parameters
Output
Delete Bank Account
Delete Bank Account
Delete Contact
Delete Contact
Delete Template
Delete Template
Delete Template Editor Session
Delete Template Editor Session
Delete Tracker
Delete Tracker
Delete Webhook
Delete Webhook
Fill Test Return Envelope Order
Fill Test Return Envelope Order
Get Bank Account
Get Bank Account
Get Box
Get Box
Get Cheque
Get Cheque
Get Contact
Get Contact
Get Letter
Get Letter
Get Postcard
Get Postcard
Get Return Envelope
Get Return Envelope
Get Return Envelope Order
Get Return Envelope Order
Get Template
Get Template
Get Tracker
Get Tracker
Get Webhook
Get Webhook
List Bank Accounts
List Bank Accounts
List Box Orders
List Box Orders
List Cheques
List Cheques
List Contacts
List Contacts
List Webhook Events
List Webhook Events
List Letters
List Letters
List Postal Statements
List Postal Statements
List Postcards
List Postcards
List Return Envelope Orders
List Return Envelope Orders
List Return Envelopes
List Return Envelopes
List Self-Mailers
List Self-Mailers
List Sub-Organizations
List Sub-Organizations
List Template Editor Sessions
List Template Editor Sessions
List Templates
List Templates
List Trackers
List Trackers
List Tracker Visits
List Tracker Visits
List Webhook Invocations
List Webhook Invocations
List Webhooks
List Webhooks
Progress Test Box
Progress Test Box
Progress Test Cheque
Progress Test Cheque
POSTGRID_PROGRESS_TEST_CHEQUETool 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
Output
Progress Test Postcard
Progress Test Postcard
Update Template
Update Template
Update Tracker
Update Tracker
POSTGRID_UPDATE_TRACKERTool 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
Output
Update Webhook
Update Webhook
POSTGRID_UPDATE_WEBHOOKTool to update an existing webhook configuration. Use when you need to modify webhook URL, events, or other settings.