API_KEY
postgrid_api_key
Developer setup
No fields declared in this snapshot.
User connection
- PostGrid API Keygeneric_api_key · stringRequired
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.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
60
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 60 actions
POSTGRID_CANCEL_BOX
Tool to cancel a box order by its ID. Use when you need to cancel a pending box shipment.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_CANCEL_POSTCARD
Tool to cancel a postcard order. Use when you need to cancel a postcard that has status 'ready'.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_CREATE_BANK_ACCOUNT
Tool to create a new bank account for print & mail service.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_CREATE_CONTACT
Tool to create a new contact in PostGrid. Use after collecting contact's name, address, and optional metadata.
Untrusted display-only summary
POSTGRID_CREATE_LETTER
Tool to create and send a letter via PostGrid. Use when recipient, sender, and content details are ready.
Untrusted display-only summary
POSTGRID_CREATE_POSTCARD
Tool to create and send a postcard via PostGrid. Use when recipient, sender, and content (HTML, template, or PDF) are ready.
Untrusted display-only summary
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.
Untrusted display-only summary
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).
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_CREATE_WEBHOOK
Tool to create a new webhook to receive order event notifications. Use after configuring your endpoint to handle webhook payloads.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_DELETE_CONTACT
Tool to delete a contact by its ID. Use when you need to remove obsolete contacts after confirming their identifier.
Untrusted display-only summary
POSTGRID_DELETE_TEMPLATE
Tool to delete a template by its ID. Use when you need to remove an existing template after confirming its identifier.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_DELETE_TRACKER
Tool to delete a tracker by its ID. Use when you need to remove an existing tracker after confirming its identifier.
Untrusted display-only summary
POSTGRID_DELETE_WEBHOOK
Tool to delete a webhook subscription. Use when you need to remove an existing webhook by its ID.
Untrusted display-only summary
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.
Untrusted display-only summary
POSTGRID_GET_BANK_ACCOUNT
Tool to retrieve a bank account. Use after obtaining the bank account ID to fetch its details.
Untrusted display-only summary
POSTGRID_GET_BOX
Tool to retrieve a specific box order by ID. Use after obtaining the box ID to fetch its details.
Untrusted display-only summary
POSTGRID_GET_CHEQUE
Tool to retrieve a specific cheque by ID. Use when you need to fetch details of a specific cheque order.
Untrusted display-only summary
POSTGRID_GET_CONTACT
Tool to retrieve a contact. Use after obtaining the contact ID to fetch its details.
Untrusted display-only summary
POSTGRID_GET_LETTER
Tool to retrieve a letter. Use after you have the letter ID to fetch its details.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.