Skip to content
PostGrid PostGrid
Get started
Overview

API Reference

Libraries

TypeScript
0.5.2
npm install postgrid-node
Read Docs
Python
2.1.1
pip install postgrid-python
Read Docs

API Overview

Address Verification

Standard Address Verification API.

Provides endpoints to verify and standardize addresses across US and Canada, supporting both structured and freeform inputs.

Note that this uses a different set of lookups than our international API.

Verify
POST/v1/addver/verifications

Intl Address Verification

International Address Verification API.

Provides endpoints to verify and standardize international addresses, supporting both structured and freeform inputs.

Verify
POST/v1/intl_addver/verifications
Create Bank Account
POST/print-mail/v1/bank_accounts
List Bank Accounts
GET/print-mail/v1/bank_accounts
Get Bank Account
GET/print-mail/v1/bank_accounts/{id}
Delete Bank Account
DELETE/print-mail/v1/bank_accounts/{id}

The campaigns API enables you to send out large volumes of fully personalized mail to a mailing list.

Create Campaign
POST/print-mail/v1/campaigns
List Campaigns
GET/print-mail/v1/campaigns
Get Campaign
GET/print-mail/v1/campaigns/{id}
Update Campaign
POST/print-mail/v1/campaigns/{id}
Delete Campaign
DELETE/print-mail/v1/campaigns/{id}
Send Campaign
POST/print-mail/v1/campaigns/{id}/send
Create Cheque
POST/print-mail/v1/cheques
List Cheques
GET/print-mail/v1/cheques
Get Cheque
GET/print-mail/v1/cheques/{id}
Cancel Cheque
DELETE/print-mail/v1/cheques/{id}
Get Cheque Preview
GET/print-mail/v1/cheques/{id}/url
Retrieve Cheque Deposit-Ready PDF (Digital Only)
GET/print-mail/v1/cheques/{id}/with_deposit_ready_pdf
Create Contact
POST/print-mail/v1/contacts
List Contacts
GET/print-mail/v1/contacts
Get Contact
GET/print-mail/v1/contacts/{id}
Delete Contact
DELETE/print-mail/v1/contacts/{id}
Create Letter
POST/print-mail/v1/letters
List Letters
GET/print-mail/v1/letters
Get Letter
GET/print-mail/v1/letters/{id}
Cancel Letter
DELETE/print-mail/v1/letters/{id}
Get Letter Preview
GET/print-mail/v1/letters/{id}/url

The mailing list imports API enables you to import contact lists from files and validate them for use in campaigns.

Create Mailing List Import
POST/print-mail/v1/mailing_list_imports
List Mailing List Imports
GET/print-mail/v1/mailing_list_imports
Update Mailing List Import
POST/print-mail/v1/mailing_list_imports/{id}
Get Mailing List Import
GET/print-mail/v1/mailing_list_imports/{id}
Delete Mailing List Import
DELETE/print-mail/v1/mailing_list_imports/{id}
Create Mailing List
POST/print-mail/v1/mailing_lists
List Mailing Lists
GET/print-mail/v1/mailing_lists
Get Mailing List
GET/print-mail/v1/mailing_lists/{id}
Update Mailing List
POST/print-mail/v1/mailing_lists/{id}
Delete Mailing List
DELETE/print-mail/v1/mailing_lists/{id}
Submit a Mailing List Job
POST/print-mail/v1/mailing_lists/{id}/jobs

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Cheque Profile
POST/print-mail/v1/order_profiles/cheques
List Cheque Profiles
GET/print-mail/v1/order_profiles/cheques
Retrieve Cheque Profile
GET/print-mail/v1/order_profiles/cheques/{id}
Update Cheque Profile
POST/print-mail/v1/order_profiles/cheques/{id}
Delete Cheque Profile
DELETE/print-mail/v1/order_profiles/cheques/{id}

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Letter Profile
POST/print-mail/v1/order_profiles/letters
List Letter Profiles
GET/print-mail/v1/order_profiles/letters
Retrieve Letter Profile
GET/print-mail/v1/order_profiles/letters/{id}
Update Letter Profile
POST/print-mail/v1/order_profiles/letters/{id}
Delete Letter Profile
DELETE/print-mail/v1/order_profiles/letters/{id}

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Postcard Profile
POST/print-mail/v1/order_profiles/postcards
List Postcard Profiles
GET/print-mail/v1/order_profiles/postcards
Retrieve Postcard Profile
GET/print-mail/v1/order_profiles/postcards/{id}
Update Postcard Profile
POST/print-mail/v1/order_profiles/postcards/{id}
Delete Postcard Profile
DELETE/print-mail/v1/order_profiles/postcards/{id}

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Self-Mailer Profile
POST/print-mail/v1/order_profiles/self_mailers
List Self-Mailer Profiles
GET/print-mail/v1/order_profiles/self_mailers
Retrieve Self-Mailer Profile
GET/print-mail/v1/order_profiles/self_mailers/{id}
Update Self-Mailer Profile
POST/print-mail/v1/order_profiles/self_mailers/{id}
Delete Self-Mailer Profile
DELETE/print-mail/v1/order_profiles/self_mailers/{id}
Create Postcard
POST/print-mail/v1/postcards
List Postcards
GET/print-mail/v1/postcards
Get Postcard
GET/print-mail/v1/postcards/{id}
Cancel Postcard
DELETE/print-mail/v1/postcards/{id}
Get Postcard Preview
GET/print-mail/v1/postcards/{id}/url

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Create Saved Report
POST/print-mail/v1/reports
Run Ad-hoc Query
POST/print-mail/v1/reports/samples
Update Report
POST/print-mail/v1/reports/{id}
List Saved Reports
GET/print-mail/v1/reports
Retrieve Saved Report
GET/print-mail/v1/reports/{id}
Delete Saved Report
DELETE/print-mail/v1/reports/{id}

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Sample a Saved Report
POST/print-mail/v1/reports/{id}/samples

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Create a Report Export
POST/print-mail/v1/reports/{reportID}/exports
Get Report Export
GET/print-mail/v1/reports/{reportID}/exports/{exportID}
Delete Report Export
DELETE/print-mail/v1/reports/{reportID}/exports/{exportID}
Create Self Mailer
POST/print-mail/v1/self_mailers
List Self Mailers
GET/print-mail/v1/self_mailers
Get Self Mailer
GET/print-mail/v1/self_mailers/{id}
Cancel Self Mailer
DELETE/print-mail/v1/self_mailers/{id}
Get Self Mailer Preview
GET/print-mail/v1/self_mailers/{id}/url

Sub-organizations enable you to create isolated PostGrid accounts ("sub-organizations") under your PostGrid account (the "parent organization"). Each sub-organization has fully isolated resources and users, and can act independently.

This allows you to isolate different departments or even re-sell PostGrid entirely.

You can request access to this feature by reaching out to [email protected]

Create a sub-organization.
POST/print-mail/v1/sub_organizations
List sub-organizations.
GET/print-mail/v1/sub_organizations
Get a sub-organization.
GET/print-mail/v1/sub_organizations/{id}
List users for a sub-organization.
GET/print-mail/v1/sub_organizations/{id}/users
Create Template
POST/print-mail/v1/templates
List Templates
GET/print-mail/v1/templates
Get Template
GET/print-mail/v1/templates/{id}
Update Template
POST/print-mail/v1/templates/{id}
Delete Template
DELETE/print-mail/v1/templates/{id}