# PostGrid integration

> Send physical mail (letters, postcards, cheques, self-mailers, snap packs, boxes) and manage contacts, templates, mailing lists, campaigns, webhooks and reports through the PostGrid Print & Mail API.

- Authentication: apiKey

## Tools (121)

- **Autocomplete Targeted List Filter Values**: Return a list of autocomplete suggestions for a given filter field (currently only `industry` is supported).
- **Cancel Box**: Cancel a box by ID (cannot be undone).
- **Cancel Cheque**: Cancel a cheque by ID. Note that this operation cannot be undone.
- **Cancel Cheque With Note**: Cancel a cheque by ID with a note. Note that this operation cannot be undone and that only cheques with a status of `ready` can be cancelled.
- **Cancel Letter**: Cancel a letter by ID. Note that this operation cannot be undone.
- **Cancel Letter With Note**: Cancel a letter by ID with a note. Note that this operation cannot be undone and that only letters with a status of `ready` can be cancelled.
- **Cancel Postcard**: Cancel a postcard by ID. Note that this operation cannot be undone.
- **Cancel Postcard With Note**: Cancel a postcard by ID with a note. Note that this operation cannot be undone and that only postcards with a status of `ready` can be cancelled.
- **Cancel Return Envelope Order**: Cancels the return envelope order by `orderID` for the return envelope by `id`. Note that this operation cannot be undone.
- **Cancel Self Mailer**: Cancel a self-mailer by ID. Note that this operation cannot be undone.
- **Cancel Snap Pack**: Cancel a snap pack by ID. Note that this operation cannot be undone and that only snap packs with a status of `ready` can be cancelled.
- **Confirm Targeted List Build**: Confirm a targeted list build whose quote is ready.
- **Create a Report Export**: Create a new export job for a saved report. This runs the report's query asynchronously and generates a downloadable CSV file with the full results.
- **Create a sub-organization**: When creating a user through the API, the verifiedEmail field will automatically be set to true.
- **Create Bank Account**: Create a bank account. A US bank account is created by setting `bankCountryCode` to `US` and providing `accountNumber` and `routingNumber`.
- **Create Box**: This endpoint allows you to create a box containing up to 100 cheques. A Box is mailed to a single destination. To create a box.
- **Create Campaign**: Create a new campaign.
- **Create Cheque**: Create a cheque. This endpoint allows you to create a new cheque with the specified details.
- **Create Contact**: Creates a contact. This will also verify the contact's address **if you create it using a live API key**.
- **Create Letter**: Create a letter.
- **Create Mailing List**: Create a new mailing list.
- **Create Mailing List Import**: Create a new mailing list import. Initiates the import process for a contact list file.
- **Create Postcard**: Create a postcard.
- **Create Return Envelope**: Creates a new return envelope.
- **Create Return Envelope Order**: Creates a batch order of return envelopes. The minimum order quantity is 5000.
- **Create Saved Report**: Create a new saved report definition. Saved reports are SQL queries that can be executed later to generate full exports or samples.
- **Create Self Mailer**: Create a self-mailer.
- **Create Snap Pack**: Create a snap pack.
- **Create Targeted List Build**: Create a new targeted list build. A quote will be generated asynchronously based on the provided filters.
- **Create Template**: Create a template. Note that if you want to create a template that works with our template editor, you must use our dashboard.
- **Create Template Editor Session**: Create a Template Editor Session. Note that if no `backURL` is supplied, PostGrid removes the Back button from the editor page.
- **Create Test Virtual Mailbox Item**: Create a test item for a virtual mailbox. This is only available in test mode, an error will be returned if you attempt this call in live mode.
- **Create Tracker**: Create a Tracker.
- **Create Virtual Mailbox**: Creates a new virtual mailbox.
- **Create Webhook**: Create a Webhook.
- **Delete Bank Account**: Delete a bank account by ID. Note that this operation cannot be undone.
- **Delete Campaign**: Delete a campaign. Campaigns can only be deleted if they are in `draft`, `changes_required`, or `ready` status.
- **Delete Contact**: Delete a contact. Note that this will not affect orders that were sent to this contact.
- **Delete Mailing List**: Delete a mailing list. This permanently deletes the mailing list and its associations. This operation cannot be undone.
- **Delete Mailing List Import**: Delete a mailing list import. This permanently deletes the import and its associated resources. This operation cannot be undone.
- **Delete Report Export**: Delete a completed or failed report export job and its associated output file (if any). This action cannot be undone.
- **Delete Saved Report**: Delete a saved report definition. This action cannot be undone. Associated exports are not automatically deleted.
- **Delete Targeted List Build**: Delete a targeted list build.
- **Delete Template**: Delete a template by ID. Note that this operation cannot be undone.
- **Delete Template Editor Session**: Delete a Template Editor Session by ID.
- **Delete Tracker**: Delete a Tracker by ID. Note that this operation cannot be undone.
- **Delete Webhook**: Delete a Webhook by ID. Note that this operation cannot be undone.
- **Fill Test Return Envelope Order**: Fills the return envelope order by `orderID` for the return envelope by `id`.
- **Get a sub-organization**: Get a sub-organization
- **Get Bank Account**: Retrieve a bank account by ID. Note that we do not return the complete account number or the signature image for security reasons.
- **Get Box**: Retrieve a box by ID.
- **Get Campaign**: Retrieve a specific campaign by its ID.
- **Get Cheque**: Retrieve a cheque by ID.
- **Get Cheque Preview**: Retrieve a cheque preview URL.
- **Get Contact**: Retrieve a contact.
- **Get Letter**: Retrieve a letter by ID.
- **Get Letter Preview**: Retrieve a letter preview URL.
- **Get Mailing List**: Retrieve a specific mailing list by its ID.
- **Get Mailing List Import**: Retrieve a specific mailing list import by its ID.
- **Get Postcard**: Retrieve a postcard by ID.
- **Get Postcard Preview**: Retrieve a postcard preview URL.
- **Get Report Export**: Retrieve the status and details of a specific report export job. Check the `outputURL` property for the download link once generation is complete.
- **Get Return Envelope**: Gets the information for a return envelope by `id`. This should be a unique identifying string starting with `return_envelope_`.
- **Get Return Envelope Order**: Gets a specific return envelope order by return envelope ID as `id` and return envelope order ID as `orderID`.
- **Get Self Mailer**: Retrieve a self-mailer by ID.
- **Get Self Mailer Preview**: Retrieve a self-mailer preview URL.
- **Get Snap Pack**: Retrieve a snap pack by ID.
- **Get Snap Pack Capabilities**: Provides sizes and mailing classes available for the destination.
- **Get Targeted List Build**: Retrieve a specific targeted list build by its ID.
- **Get Template**: Retrieve a template by ID.
- **Get Tracker**: Retrieve a Tracker by ID.
- **Get Webhook**: Retrieve a Webhook by ID.
- **List Bank Accounts**: Get a list of bank accounts. Note that we do not return the complete account number or the signature image for security reasons.
- **List Boxes**: List all boxes.
- **List Campaigns**: Retrieve a list of campaigns. Returns a paginated list of campaigns associated with the authenticated organization, filterable by various parameters.
- **List Cheques**: Get a list of cheques.
- **List Contacts**: Get a list of contacts.
- **List Events**: Retrieve a paginated list of Events.
- **List Letters**: Get a list of letters.
- **List Mailing List Imports**: Retrieve a list of mailing list imports. Returns a paginated list of imports associated with the authenticated organization, filterable by various parameters.
- **List Mailing Lists**: Retrieve a list of mailing lists. Returns a paginated list of mailing lists associated with the authenticated organization, filterable by various parameters.
- **List Postcards**: Get a list of postcards.
- **List Return Envelope Orders**: Gets a list of orders for the return envelope by `id`.
- **List Return Envelopes**: Gets a list of return envelopes for the user.
- **List Saved Reports**: Retrieve a list of saved reports for your organization.
- **List Self Mailers**: Get a list of self-mailers.
- **List Snap Packs**: Get a list of snap packs.
- **List sub-organizations**: List sub-organizations
- **List Targeted List Builds**: Retrieve a paginated list of targeted list builds for the authenticated organization, ordered from most recently updated to least recently updated.
- **List Template Editor Sessions**: Retrieve a paginated list of Template Editor Sessions.
- **List Templates**: Get a list of templates.
- **List Trackers**: Retrieve a paginated list of Trackers.
- **List Tracker Visits**: Retrieve a paginated list of visits for a Tracker.
- **List users for a sub-organization**: List users for a sub-organization
- **List Virtual Mailboxes**: Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query parameters to refine the list.
- **List Virtual Mailbox Items**: Lists items for a virtual mailbox.
- **List Webhook Invocations**: Retrieve a paginated list of invocations for a Webhook.
- **List Webhooks**: Retrieve a paginated list of Webhooks.
- **Progress Box Status**: Progresses a box's `status` to the next stage.
- **Progress Cheque Status**: Progresses a cheque's `status` to the next stage.
- **Progress Letter Status**: Progresses a letter's `status` to the next stage.
- **Progress Postcard Status**: Progresses a postcard's `status` to the next stage.
- **Progress Self Mailer Status**: Progresses a self-mailer's `status` to the next stage.
- **Progress Snap Pack Status**: Progresses a snap pack's `status` to the next stage.
- **Retrieve Cheque Deposit-Ready PDF (Digital Only)**: Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only be called by users with 'Admin' role.
- **Retrieve Physical Address**: Retrieves the physical address of the virtual mailbox.
- **Retrieve Saved Report**: Retrieve the details of a specific saved report by its ID.
- **Retrieve Virtual Mailbox**: Retrieve Virtual Mailbox
- **Retrieve Virtual Mailbox Item**: Retrieves a single item for a virtual mailbox.
- **Run Ad-hoc Report Query**: Run an ad-hoc SQL query against your data lake and get a sample of the results. This is useful for quickly testing queries without saving them as a report.
- **Sample a Saved Report**: Run the query associated with a saved report and get a sample of the results.
- **Send Campaign**: Send a campaign for processing. This action transitions a campaign from the `draft` status to `creating_orders`. You can optionally specify a future `sendDate`.
- **Submit a Mailing List Job**: Runs a mailing list job. Mailing list jobs allow you to add or remove contacts to your mailing list from mailing list imports or directly with contact IDs.
- **Update Campaign**: Update an existing campaign. Campaigns can only be updated if they are in the `draft` or `changes_required` status.
- **Update Mailing List**: Update an existing mailing list.
- **Update Mailing List Import**: Update an existing mailing list import.
- **Update Report**: Update an existing saved report definition. You can change the query, description, or metadata.
- **Update Targeted List Build**: Update an existing targeted list build. Only builds that have not yet been confirmed may be updated.
- **Update Template**: Update a template by ID.
- **Update Tracker**: Update a Tracker by ID.
- **Update Webhook**: Update a Webhook by ID.

Connect PostGrid in General Input: https://www.generalinput.com/apps/postgrid