# PostGrid Documentation

## Guides
- [Resizing PDF Files for Dashboard Use](https://postgrid.readme.io/docs/resizing-pdf-files-for-dashboard-use-1.md): How to resize your PDF file for manual submission to the PostGrid dashboard.
- [Address Autocomplete](https://postgrid.readme.io/docs/address-autocomplete.md)
- [Address Verification](https://postgrid.readme.io/docs/address-verification.md)
- [Bulk Verification Embed Guide](https://postgrid.readme.io/docs/bulk-verification-embed-guide.md)
- [Getting Started](https://postgrid.readme.io/docs/getting-started-1.md)
- [China Premium Dataset](https://postgrid.readme.io/docs/china-premium-dataset.md)
- [International Address Verification and Autocomplete](https://postgrid.readme.io/docs/international-address-verification-and-autocomplete.md)
- [Standard Address Verification and Autocomplete](https://postgrid.readme.io/docs/standard-address-verification-and-autocomplete.md)
- [Bulk Address Verification Tool](https://postgrid.readme.io/docs/overview-3.md)
- [Change of Address (COA)](https://postgrid.readme.io/docs/national-change-of-address-ncoa.md)
- [ActiveCampaign](https://postgrid.readme.io/docs/activecampaign.md)
- [Braze](https://postgrid.readme.io/docs/braze.md)
- [Customer.io](https://postgrid.readme.io/docs/customerio.md)
- [Figma](https://postgrid.readme.io/docs/figma-plugin.md)
- [HubSpot](https://postgrid.readme.io/docs/hubspot.md)
- [Klaviyo](https://postgrid.readme.io/docs/klaviyo.md)
- [Make](https://postgrid.readme.io/docs/make.md)
- [Send Letter](https://postgrid.readme.io/docs/send-a-letter.md)
- [Send Postcard](https://postgrid.readme.io/docs/send-postcard-1.md)
- [Send Self-mailer](https://postgrid.readme.io/docs/send-self-mailer-1.md)
- [Verify International Address](https://postgrid.readme.io/docs/verify-international-address.md)
- [Verify US and Canada Address](https://postgrid.readme.io/docs/verify-us-and-canada-address.md)
- [Automate Address Verification using Salesforce FLOWS](https://postgrid.readme.io/docs/automate-address-verification-using-saledforce-flows.md)
- [Salesforce Address Verification](https://postgrid.readme.io/docs/salesforce-address-verification.md)
- [Configuration](https://postgrid.readme.io/docs/installation-and-configuration-1.md)
- [Multiple Address Verification](https://postgrid.readme.io/docs/multiple-address-verification.md)
- [Single Address Verification](https://postgrid.readme.io/docs/single-address-verification.md)
- [Activating the Journey](https://postgrid.readme.io/docs/activating-the-journey.md)
- [Salesforce Marketing Cloud Print and Mail](https://postgrid.readme.io/docs/salesforce-marketing-cloud-print-and-mail.md)
- [Installation and Configuration](https://postgrid.readme.io/docs/installation.md)
- [Set up a Journey with PostGrid custom activity](https://postgrid.readme.io/docs/marketing-cloud-journey.md)
- [Send Letter](https://postgrid.readme.io/docs/send-letter.md)
- [Send Postcard](https://postgrid.readme.io/docs/send-postcard.md)
- [Send Self-mailer](https://postgrid.readme.io/docs/send-self-mailer.md)
- [Tracking the mailings](https://postgrid.readme.io/docs/tracking-the-mailings.md)
- [Using QR Codes and Tracking the interactions](https://postgrid.readme.io/docs/using-qr-codes-and-tracking-the-interactions.md)
- [Audience Setup](https://postgrid.readme.io/docs/audience-setup.md)
- [Sending triggered based mailings using Salesforce FLOWS](https://postgrid.readme.io/docs/automating-sendingthe-mailings-with-flows.md)
- [Creating a Bank Account](https://postgrid.readme.io/docs/creating-a-bank-account.md)
- [Setting up the Collateral](https://postgrid.readme.io/docs/creating-a-template.md)
- [Salesforce Print and Mail](https://postgrid.readme.io/docs/salesforce-print-and-mail.md)
- [Installation and Configuration](https://postgrid.readme.io/docs/installation-and-configuration.md)
- [Sending Bulk/Mass Mail Orders](https://postgrid.readme.io/docs/sending-bulkmass-mail-orders-using-postgrid-templates.md)
- [Sending Individual Mailings](https://postgrid.readme.io/docs/sending-individual-mailings.md)
- [Set additional preferences](https://postgrid.readme.io/docs/additional-prefernces.md)
- [Enable PostGrid Address Verification in store checkout](https://postgrid.readme.io/docs/enable-postgrid-address-verification-in-store-checkout.md)
- [Shopify](https://postgrid.readme.io/docs/shopify.md)
- [Test the integration in checkout](https://postgrid.readme.io/docs/test-the-integration-in-checkout.md)
- [View your analytics](https://postgrid.readme.io/docs/view-your-analytics.md)
- [Stripe](https://postgrid.readme.io/docs/stripe.md)
- [Zapier](https://postgrid.readme.io/docs/zapier.md)
- [Send PDFs With Zapier & PostGrid](https://postgrid.readme.io/docs/send-pdfs-with-zapier-postgrid-1.md)
- [MCP](https://postgrid.readme.io/docs/mcp.md)
- [Billing Setup for Sub-Organizations using the API](https://postgrid.readme.io/docs/collecting-payment-details-from-sub-orgs-using-the-api.md)
- [Impersonating your Sub-Organizations](https://postgrid.readme.io/docs/impersonating-your-sub-organizations.md)
- [Sub-Organizations Setup](https://postgrid.readme.io/docs/sub-organizations-set-p.md)
- [White Label](https://postgrid.readme.io/docs/white-label.md)
- [Creating Contacts using the API](https://postgrid.readme.io/docs/creating-contacts.md)
- [Creating Templates using the API](https://postgrid.readme.io/docs/creating-templates-using-the-api.md)
- [Enhanced Reports](https://postgrid.readme.io/docs/enhanced-reports-1.md)
- [Enhanced Reports API Integration](https://postgrid.readme.io/docs/enhanced-reports.md): View advanced built-in reports and create your own without any additional infrastructure.
- [Errors](https://postgrid.readme.io/docs/errors.md)
- [Getting Started](https://postgrid.readme.io/docs/overview.md)
- [PDF Quirks](https://postgrid.readme.io/docs/pdf-quirks.md): How PostGrid handles uploaded PDFs
- [QR Code & PURL Trackers](https://postgrid.readme.io/docs/qr-code-purl-trackers.md): Trackers allow you to track user interactions in your orders with the use of personalized URLs and QR codes
- [Using Trackers in the API](https://postgrid.readme.io/docs/using-trackers-in-the-api-1.md): An overview of how to create, view and manage Trackers via the API
- [Response Codes and Retry Logic](https://postgrid.readme.io/docs/response-codes-and-retry-logic.md)
- [Seed Mail](https://postgrid.readme.io/docs/seed-mail.md)
- [Sending Cheques using the API](https://postgrid.readme.io/docs/sending-cheques-using-the-api-1.md)
- [Sending Digital Checks using the API](https://postgrid.readme.io/docs/sending-e-checks-using-the-api.md)
- [Sending Letters using the API](https://postgrid.readme.io/docs/sending-letters-using-the-api.md)
- [Sending Postcards using the API](https://postgrid.readme.io/docs/sending-postcards-using-the-api.md)
- [Template Editor Sessions](https://postgrid.readme.io/docs/template-editor-sessions.md)
- [Carrier Tracking](https://postgrid.readme.io/docs/carrier-tracking-2.md): Get detailed tracking information about orders sent via certified/registered mail.
- [Tracking](https://postgrid.readme.io/docs/tracking-your-orders-using-the-api.md)
- [Tracking Orders using the API](https://postgrid.readme.io/docs/tracking-orders-using-the-api.md)
- [Using our Python SDK](https://postgrid.readme.io/docs/using-our-python-sdk-1.md)
- [Account Setup](https://postgrid.readme.io/docs/account-set-up.md)
- [Audience Setup](https://postgrid.readme.io/docs/audience-set-up.md)
- [Carrier Tracking](https://postgrid.readme.io/docs/carrier-tracking.md): Get detailed tracking information about orders sent via certified/registered mail.
- [Customizable Images and Backgrounds in Templates](https://postgrid.readme.io/docs/customizable-images-and-backgrounds-in-templates.md)
- [Design Guidelines](https://postgrid.readme.io/docs/design-and-templates.md)
- [Creating Templates with HTML](https://postgrid.readme.io/docs/directly-with-html.md)
- [Getting Started](https://postgrid.readme.io/docs/getting-started.md)
- [List Builder](https://postgrid.readme.io/docs/list-builder.md)
- [US Businesses with ZIP and Radius](https://postgrid.readme.io/docs/us-businesses-with-zip-and-radius.md): Target businesses in ZIP codes around a given location.
- [US Consumers with ZIP and Radius](https://postgrid.readme.io/docs/using-our-list-builder.md): Target individual consumers in ZIP codes around a given location. This guide walks you through building and purchasing a B2C mailing list using the PostGrid List Builder.
- [Additional Configuration and MFA](https://postgrid.readme.io/docs/additional-configuration-and-mfa.md)
- [Okta SAML SSO Setup](https://postgrid.readme.io/docs/okta-saml-sso-setup.md)
- [Migrate existing users to SAML SSO](https://postgrid.readme.io/docs/migrate-to-saml-sso.md)
- [Okta Configuration](https://postgrid.readme.io/docs/okta-configuration.md)
- [Postage Discount Authorizations](https://postgrid.readme.io/docs/postage-discount-authorizations.md): Leverage postage discount programs offered by mail carriers.
- [Postal Statements](https://postgrid.readme.io/docs/postal-statements.md): The Postal Statements feature provides concrete confirmation that your mail orders have been successfully printed, processed, and mailed.
- [QR Code & PURL Trackers](https://postgrid.readme.io/docs/trackers-adding-qr-code-and-purls-to-your-mailings.md): Trackers allow you to track user interactions in your orders with the use of personalized URLs and QR codes
- [Creating Templates using Template Editor](https://postgrid.readme.io/docs/using-our-built-in-template-editor.md)
- [Virtual Mailboxes](https://postgrid.readme.io/docs/virtual-mailboxes.md): Automatically manage returned mail, forward business replies, and view scans of received items.
- [Sending bulk mailers using Campaigns](https://postgrid.readme.io/docs/campaigns.md)
- [Creating letter orders using PDF Wizard](https://postgrid.readme.io/docs/creating-letter-orders-using-the-pdf-wizard.md)
- [Sending your first Cheque](https://postgrid.readme.io/docs/creating-your-first-cheque-order.md)
- [Sending your first Letter](https://postgrid.readme.io/docs/creating-your-first-letter-order.md)
- [Premium Paper](https://postgrid.readme.io/docs/premium-paper.md)
- [Premium Paper](https://postgrid.readme.io/docs/copy-of-premium-paper.md)
- [Sending your first Postcards](https://postgrid.readme.io/docs/creating-your-first-postcard-order.md)
- [Creating return envelope (BREs) orders](https://postgrid.readme.io/docs/creating-your-first-return-envelope-order.md)
- [Sending your first Self-Mailer](https://postgrid.readme.io/docs/creating-your-first-self-mailer-order.md)
- [Overview](https://postgrid.readme.io/docs/sending-mailings.md)
- [Creating a Snap Pack Order](https://postgrid.readme.io/docs/creating-a-snap-pack-order.md)
- [FAQs](https://postgrid.readme.io/docs/faqs.md)
- [Sending your first Snap Pack](https://postgrid.readme.io/docs/sending-your-first-snap-pack.md)
- [Address Changes](https://postgrid.readme.io/docs/address-changes-1.md)
- [Mailing Class: From First Class to Express Shipping](https://postgrid.readme.io/docs/mailing-options-from-first-class-to-express-shipping.md)
- [Manually Verifying Webhook Signatures](https://postgrid.readme.io/docs/manually-verifying-webhook-signatures.md)
- [Carrier Tracking](https://postgrid.readme.io/docs/carrier-tracking-1.md)
- [Tracking your Mailings](https://postgrid.readme.io/docs/tracking-your-mailings.md)
- [Webhook IPs](https://postgrid.readme.io/docs/webhook-ips.md): IPs to whitelist if you're handling PostGrid webhooks

## API Reference
- [/v1/intl_addver/completions](https://postgrid.readme.io/reference/internationalapi_complete.md): Resolves an address preview `id` (from `GET /completions`) into a full address.  Optionally verifies the resolved address through the standard US/CA verifier when `verify=true` is supplied and the address is in the US or Canada.  - Uses 1 lookup per call. - When `verify=true` resolves a US or CA address, the response will be a `VerifiedAddress` instead of an `IntlAddressCompletion`.
- [/v1/intl_addver/completions](https://postgrid.readme.io/reference/internationalapi_getcompletionpreviews.md): Returns address completion previews for a partial address string, suitable for populating an autocomplete dropdown.  **Regular mode** — supply `partialStreet` to search by partial street address. Results may include `Address` types (resolvable directly) and `Container` types (buildings/complexes that require a follow-up call).  **Advanced mode** — supply `advanced=true` and a `container` ID (from a previous regular call) to drill into a building or complex and retrieve individual unit addresses.  Results with `type: "Address"` can be fully resolved by passing their `id` to `POST /completions`.  - Does not consume a lookup.
- [/v1/intl_addver/verifications](https://postgrid.readme.io/reference/internationalapi_verifyaddress.md): Verify and standardize an international address.  - Supports both structured and freeform address inputs. - Specify `includeDetails=true` to get additional details as per the `IntlDetails` schema. - Uses 1 lookup.
- [/v1/intl_addver/verifications/batch](https://postgrid.readme.io/reference/internationalapi_verifybatch.md): Verify a batch of international addresses in a single request. Each address can be freeform or structured, matching the same input formats accepted by the single verification endpoint.  - Uses 1 lookup per address. - Requires a secret API key. - Returns results in the same order as the input addresses. - If an individual address fails, its result will contain an `error` field rather than a `verifiedAddress`.
- [/v1/addver/completions](https://postgrid.readme.io/reference/standardapi_complete.md): Resolves a partial street address into a list of full address candidates, optionally selecting a specific candidate by index and verifying it.  **Basic usage** — omit `index`: returns an array of `CompletedAddressItem` results for the given `partialStreet`.  **With `index`** — specify `index` to resolve a single candidate. Returns a single `CompletedAddressItem`.  **With `index` + `verify=true`** — additionally runs the selected address through the USPS/Canada Post verifier and returns a `StandardVerifiedAddress`.  - Uses 1 lookup per call (plus 1 more if geocoding a result).
- [/v1/addver/completions](https://postgrid.readme.io/reference/standardapi_getcompletionpreviews.md): Returns address completion previews for a partial street address, suitable for populating an autocomplete dropdown without consuming a lookup per keystroke.  Each result contains a partial address preview (street, city, and — for non-US addresses — only the first 3 digits of the postal code, to avoid revealing the full code before a lookup is charged).  - Does not consume a lookup. - Use `POST /completions` to resolve a full address once the user selects a result.
- [/v1/addver/](https://postgrid.readme.io/reference/standardapi_getlookupinfo.md): Returns your organization's current lookup usage and plan information. Useful for checking how many lookups you have consumed and whether you are on a paid plan.
- [/v1/addver/city_states](https://postgrid.readme.io/reference/standardapi_lookupcitycounty.md): Looks up city, county, and other location metadata for a given US or Canadian postal code or ZIP code.  A single postal code may map to multiple cities (e.g. a ZIP that spans several towns), so the response is an array.  - Uses 1 lookup.
- [/v1/addver/zip_codes](https://postgrid.readme.io/reference/standardapi_lookupzipcodes.md): Looks up all ZIP codes that correspond to a given US city and state.  - Currently only supported for US addresses (`countryCode: "US"`). - Uses 1 lookup.
- [/v1/addver/parses](https://postgrid.readme.io/reference/standardapi_parseaddress.md): Parses a freeform address string into its individual components (house number, street name, city, state, postal code, etc.).  Useful for extracting structured data from a single-line address without running a full verification.  - Uses 1 lookup.
- [/v1/addver/suggestions](https://postgrid.readme.io/reference/standardapi_suggestaddress.md): Returns up to 3 verified address suggestions for a given input address.  Useful as a fallback when `POST /verifications` returns a `failed` status — suggestions represent the closest matches found and may help the user identify the correct address.  Accepts the same freeform or structured input formats as `POST /verifications`.  - Uses 1 lookup per call (plus 1 more if geocoding).
- [/v1/addver/verifications](https://postgrid.readme.io/reference/standardapi_verifyaddress.md): 1. **Structured Address** — Verify and standardize a structured address (e.g., with `line1`, `city`, etc.). 2. **Freeform Address** — Verify and standardize a freeform address written on one line. For best results, append the ISO 2-letter country code (e.g., `US`, `CA`) to the end of the line.  - Specifying `includeDetails=true` will provide additional output as documented in the `Details` schema. - Uses 1 lookup for verification, and 1 more if geocoding (unless your contract says otherwise).
- [/v1/addver/verifications/batch](https://postgrid.readme.io/reference/standardapi_verifybatch.md): Verify a batch of US or Canadian addresses in a single request. Each address can be freeform or structured, matching the same input formats accepted by the single verification endpoint.  - Uses 1 lookup per address (plus 1 more per address if geocoding). - Requires a secret API key. - Returns results in the same order as the input addresses. - If an individual address fails, its result will contain an `error` field rather than a `verifiedAddress`.
- [Create Bank Account](https://postgrid.readme.io/reference/bankaccounts_create-1.md): Create a bank account. A US bank account is created by setting `bankCountryCode` to `US` and providing `accountNumber` and `routingNumber`. A canadian bank account can be created by specifying `bankCountryCode` as `CA` and setting `accountNumber`, `routeNumber`, and `transitNumber` accordingly.  You must specify _either_ `signatureImage` or `signatureText`. The image can be supplied as either a URL or a multipart file upload.
- [Delete Bank Account](https://postgrid.readme.io/reference/bankaccounts_delete-1.md): Delete a bank account by ID. Note that this operation cannot be undone.
- [Get Bank Account](https://postgrid.readme.io/reference/bankaccounts_get-1.md): Retrieve a bank account by ID.
- [List Bank Accounts](https://postgrid.readme.io/reference/bankaccounts_list-1.md): Get a list of bank accounts.
- [Bank Accounts](https://postgrid.readme.io/reference/bank-accounts.md)
- [Create Box](https://postgrid.readme.io/reference/boxes_create-1.md): 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. You must specify: - `to`: The recipient (contact or contact ID) - `from`: The sender (contact or contact ID) - `cheques`: An array of cheques to go in the box  For each cheque You must specify: - `to`: The recipient (contact or contact ID) - `from`: The sender (contact or contact ID) - `bankAccount`: The bank account ID - `amount`: The amount to be sent - `number`: The cheque number
- [Cancel Box](https://postgrid.readme.io/reference/boxes_delete-1.md): Cancel a box by ID (cannot be undone).
- [Get Box](https://postgrid.readme.io/reference/boxes_get-1.md): Retrieve a box by ID.
- [List Boxes](https://postgrid.readme.io/reference/boxes_list-1.md): List all boxes.
- [Progress Status](https://postgrid.readme.io/reference/boxes_progress.md): Progresses a box's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Create Campaign](https://postgrid.readme.io/reference/campaigns_create-1.md): Create a new campaign.  A campaign links a mailing list with a specific mail piece configuration (letter, postcard, cheque, self-mailer, or snap pack) to send bulk mail. Only one collateral type can be set per campaign.  Upon creation, the campaign enters the `drafting` status while assets are validated.
- [Delete Campaign](https://postgrid.readme.io/reference/campaigns_delete-1.md): Delete a campaign.  Campaigns can only be deleted if they are in `draft`, `changes_required`, or `ready` status. This also permanently deletes associated resources. This operation cannot be undone.
- [Get Campaign](https://postgrid.readme.io/reference/campaigns_get-1.md): Retrieve a specific campaign by its ID.
- [List Campaigns](https://postgrid.readme.io/reference/campaigns_list-1.md): Retrieve a list of campaigns.  Returns a paginated list of campaigns associated with the authenticated organization, filterable by various parameters.
- [Send Campaign](https://postgrid.readme.io/reference/campaigns_send-1.md): Send a campaign for processing.  This action transitions a campaign from the `draft` status to `creating_orders`. You can optionally specify a future `sendDate`. Once sent, the campaign cannot be updated.
- [Update Campaign](https://postgrid.readme.io/reference/campaigns_update-1.md): Update an existing campaign.  Campaigns can only be updated if they are in the `draft` or `changes_required` status. Updating a campaign will trigger reprocessing and set its status back to `drafting`.
- [Cancel Cheque With Note](https://postgrid.readme.io/reference/cheques_cancelwithnote.md): 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.
- [Create Cheque](https://postgrid.readme.io/reference/cheques_create-1.md): Create a cheque.  This endpoint allows you to create a new cheque with the specified details.  If you would like to create a digitalOnly cheque, the digitalOnly object with the watermark will need to be passed in. Feature is available on request, e-mail support@postgrid.com for access.  Example request body:  ```json {   "from": "contact_123",   "bankAccount": "bank_123",   "amount": 1000,   "currencyCode": "USD",   "number": 123456,   "size": "us_letter",   "digitalOnly": {     "watermark": "VOID"   } } ```
- [Cancel Cheque](https://postgrid.readme.io/reference/cheques_delete-1.md): Cancel a cheque by ID. Note that this operation cannot be undone.
- [Get Cheque](https://postgrid.readme.io/reference/cheques_get-1.md): Retrieve a cheque by ID.
- [Retrieve Cheque Deposit-Ready PDF (Digital Only)](https://postgrid.readme.io/reference/cheques_getdepositreadypdf-1.md): Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only be called by users with 'Admin' role. In test mode, the preview PDF of the digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the deposit-ready will have the full account number.
- [Get Cheque Preview](https://postgrid.readme.io/reference/cheques_geturl-1.md): Retrieve a cheque preview URL.  This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.
- [List Cheques](https://postgrid.readme.io/reference/cheques_list-1.md): Get a list of cheques.
- [Progress Status](https://postgrid.readme.io/reference/cheques_progress.md): Progresses a cheque's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Cheques](https://postgrid.readme.io/reference/cheques.md)
- [Create Contact](https://postgrid.readme.io/reference/contacts_create-1.md): Creates a contact. This will also verify the contact's address **if you create it using a live API key**. To sucessfully create a contact, either a `firstName`, a `companyName`, or both are required. You can supply both, but you **cannot** supply neither.  You have the option to supply the entire address (except for `countryCode`) via `addressLine1`, in which case PostGrid will parse it automatically. However, this is **not guaranteed to be correct**, so we recommend passing along the structured address fields (`city`, `provinceOrState`, etc) if you have them.  _Note that if you create a contact that has identical information to another contact, this will simply update the description of the existing contact and return it. This avoids creating duplicate contacts._
- [Delete Contact](https://postgrid.readme.io/reference/contacts_delete-1.md): Delete a contact. Note that this will not affect orders that were sent to this contact.
- [Get Contact](https://postgrid.readme.io/reference/contacts_get-1.md): Retrieve a contact.
- [List Contacts](https://postgrid.readme.io/reference/contacts_list-1.md): Get a list of contacts.
- [Contacts](https://postgrid.readme.io/reference/contacts.md)
- [Events](https://postgrid.readme.io/reference/events.md)
- [Letters](https://postgrid.readme.io/reference/letters.md)
- [Cancel Letter With Note](https://postgrid.readme.io/reference/letters_cancelwithnote.md): 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.
- [Create Letter](https://postgrid.readme.io/reference/letters_create-1.md): Create a letter. Note that you can supply one of the following: - HTML content for the letter - A template ID for the letter - A URL or file for a PDF for the letter - Upload the aforementioned PDF file via a multipart form upload request
- [Cancel Letter](https://postgrid.readme.io/reference/letters_delete-1.md): Cancel a letter by ID. Note that this operation cannot be undone.
- [Get Letter](https://postgrid.readme.io/reference/letters_get-1.md): Retrieve a letter by ID.
- [Get Letter Preview](https://postgrid.readme.io/reference/letters_geturl-1.md): Retrieve a letter preview URL.  This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.
- [List Letters](https://postgrid.readme.io/reference/letters_list-1.md): Get a list of letters.
- [Progress Status](https://postgrid.readme.io/reference/letters_progress.md): Progresses a letter's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Mailing List Imports](https://postgrid.readme.io/reference/mailing-list-imports.md)
- [Create Mailing List Import](https://postgrid.readme.io/reference/mailinglistimports_create-1.md): Create a new mailing list import.  Initiates the import process for a contact list file. The import enters the `validating` status while contacts are processed and verified.
- [Delete Mailing List Import](https://postgrid.readme.io/reference/mailinglistimports_delete-1.md): Delete a mailing list import.  This permanently deletes the import and its associated resources. This operation cannot be undone.
- [Get Mailing List Import](https://postgrid.readme.io/reference/mailinglistimports_get-1.md): Retrieve a specific mailing list import by its ID.
- [List Mailing List Imports](https://postgrid.readme.io/reference/mailinglistimports_list-1.md): Retrieve a list of mailing list imports.  Returns a paginated list of imports associated with the authenticated organization, filterable by various parameters.
- [Update Mailing List Import](https://postgrid.readme.io/reference/mailinglistimports_update-1.md): Update an existing mailing list import.
- [Mailing Lists](https://postgrid.readme.io/reference/mailing-lists.md)
- [Create Mailing List](https://postgrid.readme.io/reference/mailinglists_create-1.md): Create a new mailing list.
- [Delete Mailing List](https://postgrid.readme.io/reference/mailinglists_delete-1.md): Delete a mailing list.  This permanently deletes the mailing list and its associations. This operation cannot be undone.
- [Get Mailing List](https://postgrid.readme.io/reference/mailinglists_get-1.md): Retrieve a specific mailing list by its ID.
- [List Mailing Lists](https://postgrid.readme.io/reference/mailinglists_list-1.md): Retrieve a list of mailing lists.  Returns a paginated list of mailing lists associated with the authenticated organization, filterable by various parameters.
- [Submit a Mailing List Job](https://postgrid.readme.io/reference/mailinglists_mailinglistjobs-1.md): 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. Only one job can be ran at a time and jobs are only able to be ran while the mailing list has a `status` of  "completed".  Once a job as successfully been kicked off, the mailing list will have a `status` of either `creating_contacts` or `removing_contacts` depending on which job was ran. After the job has finished, the mailing list will go back into the `completed` state where more jobs can be ran. If there are any errors while running a job, the `errors` field on the mailing list will contain a list of error objects which describe the errors.
- [Update Mailing List](https://postgrid.readme.io/reference/mailinglists_update-1.md): Update an existing mailing list.
- [Postcards](https://postgrid.readme.io/reference/postcards.md)
- [Cancel Postcard With Note](https://postgrid.readme.io/reference/postcards_cancelwithnote.md): 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.
- [Create Postcard](https://postgrid.readme.io/reference/postcards_create-1.md): Create a postcard. Note that you can supply one of the following: - HTML content for the front and back of the postcard - A template ID for the front and back of the postcard - A URL or file for a 2 page PDF where the first page is the front of the postcard and the second page is the back - Upload the aforementioned PDF file via a multipart form upload request
- [Cancel Postcard](https://postgrid.readme.io/reference/postcards_delete-1.md): Cancel a postcard by ID. Note that this operation cannot be undone.
- [Get Postcard](https://postgrid.readme.io/reference/postcards_get-1.md): Retrieve a postcard by ID.
- [Get Postcard Preview](https://postgrid.readme.io/reference/postcards_geturl-1.md): Retrieve a postcard preview URL.  This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.
- [List Postcards](https://postgrid.readme.io/reference/postcards_list-1.md): Get a list of postcards.
- [Progress Status](https://postgrid.readme.io/reference/postcards_progress.md): Progresses a postcard's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Return Envelope Orders](https://postgrid.readme.io/reference/return-envelope-orders.md)
- [Return Envelopes](https://postgrid.readme.io/reference/return-envelopes.md)
- [Create Self Mailer](https://postgrid.readme.io/reference/selfmailers_create-1.md): Create a self-mailer. Note that you can supply one of the following: - HTML content for the inside and outside of the self-mailer - A template ID for the inside and outside of the self-mailer - A URL or file for a 2 page PDF where the first page is the outside of the self-mailer and the second page is the inside - Upload the aforementioned PDF file via a multipart form upload request
- [Cancel Self Mailer](https://postgrid.readme.io/reference/selfmailers_delete-1.md): Cancel a self-mailer by ID. Note that this operation cannot be undone.
- [Get Self Mailer](https://postgrid.readme.io/reference/selfmailers_get-1.md): Retrieve a self-mailer by ID.
- [Get Self Mailer Preview](https://postgrid.readme.io/reference/selfmailers_geturl-1.md): Retrieve a self-mailer preview URL.  This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.
- [List Self Mailers](https://postgrid.readme.io/reference/selfmailers_list-1.md): Get a list of self-mailers.
- [Progress Status](https://postgrid.readme.io/reference/selfmailers_progress.md): Progresses a self-mailer's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Cancel](https://postgrid.readme.io/reference/snappacks_cancel-1.md): 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.
- [Capabilities](https://postgrid.readme.io/reference/snappacks_capabilities-1.md): Provides sizes and mailing classes available for the destination.
- [Create Snap Pack](https://postgrid.readme.io/reference/snappacks_create-1.md): Create a snap pack. You can supply one of the following: - HTML content for the inside and outside of the snap pack - Template IDs for the inside and outside of the snap pack - A URL or file upload for a two-page PDF that matches the snap pack layout
- [Get Snap Pack](https://postgrid.readme.io/reference/snappacks_get-1.md): Retrieve a snap pack by ID.
- [List Snap Packs](https://postgrid.readme.io/reference/snappacks_list-1.md): Get a list of snap packs.
- [Progress Status](https://postgrid.readme.io/reference/snappacks_progress-1.md): Progresses a snap pack's `status` to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.  Note: this will fail with an `invalid_progression_error` if the status is one of `completed` or `cancelled`.
- [Create a sub-organization.](https://postgrid.readme.io/reference/suborganizations_create-1.md): When creating a user through the API, the verifiedEmail field will automatically be set to true. However, if public signups are used, the email will need to be verified by the user.
- [Get a sub-organization.](https://postgrid.readme.io/reference/suborganizations_get-1.md)
- [List sub-organizations.](https://postgrid.readme.io/reference/suborganizations_list-1.md)
- [List users for a sub-organization.](https://postgrid.readme.io/reference/suborganizations_listusers-1.md)
- [Autocomplete Filter Values](https://postgrid.readme.io/reference/targetedlistbuilds_autocomplete.md): Return a list of autocomplete suggestions for a given filter field (currently only `industry` is supported). Useful when building a UI around the `industries` company filter.
- [Confirm Targeted List Build](https://postgrid.readme.io/reference/targetedlistbuilds_confirm.md): Confirm a targeted list build whose quote is ready. This deducts the appropriate amount of list build credits from the organization (in live mode) and kicks off the asynchronous creation of the underlying mailing list.
- [Create Targeted List Build](https://postgrid.readme.io/reference/targetedlistbuilds_create.md): Create a new targeted list build. A quote will be generated asynchronously based on the provided filters.
- [Delete Targeted List Build](https://postgrid.readme.io/reference/targetedlistbuilds_delete.md): Delete a targeted list build. List builds can only be deleted before they have been confirmed — once a build has transitioned to `creating_list` or `completed` it cannot be deleted.
- [Get Targeted List Build](https://postgrid.readme.io/reference/targetedlistbuilds_get.md): Retrieve a specific targeted list build by its ID.
- [List Targeted List Builds](https://postgrid.readme.io/reference/targetedlistbuilds_list.md): Retrieve a paginated list of targeted list builds for the authenticated organization, ordered from most recently updated to least recently updated.
- [Update Targeted List Build](https://postgrid.readme.io/reference/targetedlistbuilds_update.md): Update an existing targeted list build. Only builds that have not yet been confirmed may be updated. Updating the filters or `limit` will reset the build's status back to `generating_quote` and a new quote will be generated.
- [Create Session](https://postgrid.readme.io/reference/templateeditorsessions_create.md): Create a Template Editor Session.  Note that if no `backURL` is supplied, PostGrid removes the Back button from the editor page. This is ideal for when you `iframe` the editor.
- [Delete Session](https://postgrid.readme.io/reference/templateeditorsessions_delete.md): Delete a Template Editor Session by ID.
- [List Sessions](https://postgrid.readme.io/reference/templateeditorsessions_list.md): Retrieve a paginated list of Template Editor Sessions.
- [Templates](https://postgrid.readme.io/reference/templates.md)
- [Create Template](https://postgrid.readme.io/reference/templates_create-1.md): Create a template. Note that if you want to create a template that works with our template editor, you must use our dashboard.
- [Delete Template](https://postgrid.readme.io/reference/templates_delete-1.md): Delete a template by ID. Note that this operation cannot be undone.
- [Get Template](https://postgrid.readme.io/reference/templates_get-1.md): Retrieve a template by ID.
- [List Templates](https://postgrid.readme.io/reference/templates_list-1.md): Get a list of templates.
- [Update Template](https://postgrid.readme.io/reference/templates_update-1.md): Update a template by ID.
- [Create Virtual Mailbox](https://postgrid.readme.io/reference/virtualmailboxes_create-1.md): Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending assignment and cannot be used until it has been assigned and activated by our team. You will be notified via email once the virtual mailbox has been activated. In test mode, the virtual mailbox will be activated immediately upon creation.
- [Create Test Virtual Mailbox Item](https://postgrid.readme.io/reference/virtualmailboxes_createtestitem-1.md): 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.
- [List Virtual Mailboxes](https://postgrid.readme.io/reference/virtualmailboxes_list-1.md): Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query parameters to refine the list.
- [List Virtual Mailbox Items](https://postgrid.readme.io/reference/virtualmailboxes_listitems-1.md): Lists items for a virtual mailbox.
- [Retrieve Virtual Mailbox](https://postgrid.readme.io/reference/virtualmailboxes_retrieve-1.md)
- [Retrieve Physical Address](https://postgrid.readme.io/reference/virtualmailboxes_retrieveaddress-1.md): Retrieves the physical address of the virtual mailbox.
- [Retrieve Virtual Mailbox Item](https://postgrid.readme.io/reference/virtualmailboxes_retrieveitem-1.md): Retrieves a single item for a virtual mailbox.
- [Webhooks](https://postgrid.readme.io/reference/webhooks.md)

## Pages
- [FAQs](https://postgrid.readme.io/faqs.md)