Print Mail
Print MailContacts
Create Contact
List Contacts
Delete Contact
ModelsExpand Collapse
class Contact: …
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
class ContactCreateWithFirstName: …
class ContactCreateWithCompanyName: …
class ContactCreateWithCompanyName: …
class ContactCreateWithFirstName: …
Print MailTemplates
Create Template
List Templates
Update Template
Delete Template
Print MailTrackers
Create and manage Trackers.
Trackers can be used to track interactions in your orders through personalized URLs and QR codes.
As a brief introduction to using Trackers in your orders, a QR code can be generated by using the Tracker’s ID as a merge variable in your orders HTML and Templates. The following example HTML uses Trackers to generate personalized URLs (PURLs) in your orders.
See the following guide for more details: https://postgrid.readme.io/reference/trackers-1
Create Tracker
List Trackers
Update Tracker
Get Tracker
Delete Tracker
List Tracker Visits
ModelsExpand Collapse
Print MailLetters
Create Letter
List Letters
Get Letter Preview
Cancel Letter With Note
Progress Status
ModelsExpand Collapse
class Letter: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The HTML content for the letter. You can supply either this or template but not both.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
paper: Optional[Union[Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"], str, null]]Premium paper selection used for this letter.
Available values include:
standardpremium_paper_letter_standard_white_70lbpremium_paper_letter_standard_white_80lb
Not all premium paper options are enabled for all organizations.
If omitted, the organization default letter paper is used when configured; otherwise standard.
Premium paper selection used for this letter.
Available values include:
standardpremium_paper_letter_standard_white_70lbpremium_paper_letter_standard_white_80lb
Not all premium paper options are enabled for all organizations.
If omitted, the organization default letter paper is used when configured; otherwise standard.
If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.
plastic_card: Optional[PlasticCard]Model representing a plastic card.
Model representing a plastic card.
The template ID used for the letter. You can supply either this or html but not both.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailPostcards
Create Postcard
List Postcards
Get Postcard Preview
Cancel Postcard With Note
Progress Status
ModelsExpand Collapse
class Postcard: …
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
from_: Optional[Contact]The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
paper: Optional[Union[Literal["standard", "premium_paper_heavy_1_glossy", "premium_paper_postcard_uv_glossy_ss", 2 more], str, null]]Premium paper selection used for this postcard.
Available values include:
standardpremium_paper_heavy_1_glossypremium_paper_postcard_uv_glossy_sspremium_paper_postcard_uv_glossy_ss_120lbpremium_paper_postcard_satin_ds
Not all premium paper options are enabled for all organizations.
If omitted, the organization default postcard paper is used when configured; otherwise standard.
Premium paper selection used for this postcard.
Available values include:
standardpremium_paper_heavy_1_glossypremium_paper_postcard_uv_glossy_sspremium_paper_postcard_uv_glossy_ss_120lbpremium_paper_postcard_satin_ds
Not all premium paper options are enabled for all organizations.
If omitted, the organization default postcard paper is used when configured; otherwise standard.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailBank Accounts
Create Bank Account
List Bank Accounts
Get Bank Account
Delete Bank Account
ModelsExpand Collapse
class BankAccount: …
Countries typically have different bank account formats and standards. These are the countries
which PostGrid’s bank accounts API supports.
Countries typically have different bank account formats and standards. These are the countries which PostGrid’s bank accounts API supports.
An optional string describing this resource. Will be visible in the API and the dashboard.
A signed link to the signature image uploaded when this bank account was created. This is omitted if signatureText is present.
Print MailCheques
Create Cheque
List Cheques
Get Cheque Preview
Retrieve Cheque Deposit-Ready PDF (Digital Only)
Cancel Cheque With Note
Progress Status
ModelsExpand Collapse
class Cheque: …
currency_code: Literal["USD", "CAD"]The currency code of the cheque. This can be USD even if drawing from a Canadian bank account and vice versa. Defaults to the currency of the bank account country if not otherwise specified.
The currency code of the cheque. This can be USD even if drawing from a Canadian bank account and vice versa. Defaults to the currency of the bank account country if not otherwise specified.
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
A link to the deposit-ready PDF for a digital-only cheque, returned if requested and available.
An optional string describing this resource. Will be visible in the API and the dashboard.
digital_only: Optional[DigitalOnly]The digitalOnly object contains data for digital-only cheques. A watermark must be provided.
The digitalOnly object contains data for digital-only cheques. A watermark must be provided.
envelope: Optional[Union[Literal["standard"], str, null]]The envelope of the cheque. If a custom envelope ID is not specified, defaults to standard.
The envelope of the cheque. If a custom envelope ID is not specified, defaults to standard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
An optional logo URL for the cheque. This will be placed next to the recipient address at the top left corner of the cheque. This needs to be a public link to an image file (e.g. a PNG or JPEG file).
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The number of the cheque. If you don’t provide this, it will automatically be set to an incrementing number starting from 1 across your entire account, ensuring that every cheque has a unique number.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailSelf Mailers
Create Self Mailer
List Self Mailers
Get Self Mailer
Cancel Self Mailer
Get Self Mailer Preview
Progress Status
ModelsExpand Collapse
class SelfMailer: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
size: Literal["8.5x11_bifold", "8.5x11_trifold", "9.5x16_trifold"]Enum representing the supported self-mailer sizes.
Enum representing the supported self-mailer sizes.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailCampaigns
The campaigns API enables you to send out large volumes of fully personalized mail to a mailing list.
Create Campaign
List Campaigns
Update Campaign
Delete Campaign
Send Campaign
ModelsExpand Collapse
class Campaign: …Represents a bulk mail campaign.
Represents a bulk mail campaign.
status: Literal["drafting", "changes_required", "creating_orders", 4 more]Status of the campaign lifecycle.
Status of the campaign lifecycle.
cheque: Optional[Cheque]Inline cheque configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
Inline cheque configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
letter_settings: Optional[ChequeLetterSettings]Settings for the attached letter (e.g., color printing).
Settings for the attached letter (e.g., color printing).
ID of a template for an optional attached letter. Cannot be used with letterPDF.
The ID of the default sender contact to use for orders if not specified per recipient.
An optional string describing this resource. Will be visible in the API and the dashboard.
errors: Optional[List[Error]]A list of processing errors encountered, if any. Present when status is ‘changes_required’.
A list of processing errors encountered, if any. Present when status is ‘changes_required’.
letter: Optional[Letter]Inline letter configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
Inline letter configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
address_placement: Optional[AddressPlacement]Enum representing the placement of the address on the letter.
Enum representing the placement of the address on the letter.
envelope_type: Optional[Literal["standard_double_window", "flat"]]The type of envelope used for the letter.
The type of envelope used for the letter.
mailing_class: Optional[Literal["first_class", "standard_class", "express", 23 more]]Mailing class for the letter.
Mailing class for the letter.
paper: Optional[Union[Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"], str, null]]Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.
Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.
A temporary URL to preview the first rendered order, available once the campaign status is ‘draft’ or later.
postcard: Optional[Postcard]Inline postcard configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
Inline postcard configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
mailing_class: Optional[Literal["first_class", "standard_class", "express", 23 more]]Mailing class for the postcard.
Mailing class for the postcard.
paper: Optional[Union[Literal["standard", "premium_paper_heavy_1_glossy", "premium_paper_postcard_uv_glossy_ss", 2 more], str, null]]Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.
Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.
A temporary URL to download the processing report, available once the campaign is in the ready status.
self_mailer: Optional[SelfMailer]Inline self-mailer configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
Inline self-mailer configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.
The scheduled date and time for the campaign to be sent.
Print MailMailing List Imports
The mailing list imports API enables you to import contact lists from files and validate them for use in campaigns.
Create Mailing List Import
List Mailing List Imports
Update Mailing List Import
Get Mailing List Import
Delete Mailing List Import
ModelsExpand Collapse
class MailingListImportResponse: …Read-only view of a MailingListImport
Read-only view of a MailingListImport
errors: List[Error]A list of processing errors encountered, if any. Present when status is ‘changes_required’.
A list of processing errors encountered, if any. Present when status is ‘changes_required’.
file: FileThe file object your controller returns: all the mappings plus a signed URL.
The file object your controller returns: all the mappings plus a signed URL.
Mapping of columns for receiver addresses. Contact fields to file columns. Possible Contact fields:
- description
- firstName
- lastName
- phoneNumber
- companyName
- addressLine1
- addressLine2
- jobTitle
- city
- postalOrZip
- provinceOrState
- countryCode
status: Literal["validating", "completed", "changes_required"]Status of the mailing list import process.
Status of the mailing list import process.
An optional string describing this resource. Will be visible in the API and the dashboard.
A temporary URL to download the processing report, available once the import is completed.
Print MailMailing Lists
The mailing lists API enables you to manage collections of contacts that can be used for bulk mail campaigns.
Create Mailing List
List Mailing Lists
Get Mailing List
Update Mailing List
Delete Mailing List
Submit a Mailing List Job
ModelsExpand Collapse
class MailingList: …Represents a mailing list.
Represents a mailing list.
status: Literal["creating_contacts", "removing_contacts", "counting_recipient_country_codes", "completed"]Status of the mailing list processing.
Status of the mailing list processing.
An optional string describing this resource. Will be visible in the API and the dashboard.
Print MailReports
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 support@postgrid.com
Create Saved Report
Run Ad-hoc Query
Update Report
List Saved Reports
Delete Saved Report
Print MailReportsSamples
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 support@postgrid.com
Sample a Saved Report
Print MailReportsExports
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 support@postgrid.com
Create a Report Export
Get Report Export
Delete Report Export
ModelsExpand Collapse
class ReportExport: …Represents a report export job and its results.
Represents a report export job and its results.
Timestamp when the export was last updated (e.g., finished generation).
Print MailSub Organizations
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 support@postgrid.com
Create a sub-organization.
List sub-organizations.
Get a sub-organization.
List users for a sub-organization.
ModelsExpand Collapse
class SubOrganizationCreateResponse: …
The Sub-Organization object.
The Sub-Organization object.
user: UserThe user object.
The user object.
Print MailBoxes
Create Box
List Boxes
Progress Status
ModelsExpand Collapse
class BoxCreateResponse: …
cheques: List[Cheque]The cheques inside this box (in read mode).
The cheques inside this box (in read mode).
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class BoxListResponse: …
cheques: List[Cheque]The cheques inside this box (in read mode).
The cheques inside this box (in read mode).
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class BoxRetrieveResponse: …
cheques: List[Cheque]The cheques inside this box (in read mode).
The cheques inside this box (in read mode).
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class BoxDeleteResponse: …
cheques: List[Cheque]The cheques inside this box (in read mode).
The cheques inside this box (in read mode).
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class BoxProgressionsResponse: …
cheques: List[Cheque]The cheques inside this box (in read mode).
The cheques inside this box (in read mode).
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
The contact of the ‘from’ field in read mode should be a fully expanded Contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailSnap Packs
Snap packs are pressure-sealed mailers that resemble official documents and encourage higher open rates. They do not require envelopes and are opened by tearing along perforated edges. The sealed design keeps contents hidden until opened, making snap packs ideal for sensitive or important documents such as contracts, forms, or notices.
You can request access to this feature by reaching out to support@postgrid.com
Create Snap Pack
List Snap Packs
Capabilities
Get Snap Pack
Cancel
Progress Status
ModelsExpand Collapse
class SnapPackCreateResponse: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
The HTML content for the inside of the snap pack, when provided instead of a template or PDF.
The template ID for the inside of the snap pack, when provided instead of HTML or PDF.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The HTML content for the outside of the snap pack, when provided instead of a template or PDF.
The template ID for the outside of the snap pack, when provided instead of HTML or PDF.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class SnapPackListResponse: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
The HTML content for the inside of the snap pack, when provided instead of a template or PDF.
The template ID for the inside of the snap pack, when provided instead of HTML or PDF.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The HTML content for the outside of the snap pack, when provided instead of a template or PDF.
The template ID for the outside of the snap pack, when provided instead of HTML or PDF.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class SnapPackRetrieveResponse: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
The HTML content for the inside of the snap pack, when provided instead of a template or PDF.
The template ID for the inside of the snap pack, when provided instead of HTML or PDF.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The HTML content for the outside of the snap pack, when provided instead of a template or PDF.
The template ID for the outside of the snap pack, when provided instead of HTML or PDF.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class SnapPackDeleteResponse: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
The HTML content for the inside of the snap pack, when provided instead of a template or PDF.
The template ID for the inside of the snap pack, when provided instead of HTML or PDF.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The HTML content for the outside of the snap pack, when provided instead of a template or PDF.
The template ID for the outside of the snap pack, when provided instead of HTML or PDF.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
class SnapPackProgressionsResponse: …
The contact information of the sender.
The contact information of the sender.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
mailing_class: Literal["first_class", "standard_class", "express", 23 more]The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.
This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.
status: Literal["ready", "printing", "processed_for_delivery", 2 more]See OrderStatus for more details on the status of this order.
See OrderStatus for more details on the status of this order.
The recipient of this order. This will be provided even if you delete the underlying contact.
The recipient of this order. This will be provided even if you delete the underlying contact.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
cancellation: Optional[Cancellation]The cancellation details of this order. Populated if the order has been cancelled.
The cancellation details of this order. Populated if the order has been cancelled.
An optional string describing this resource. Will be visible in the API and the dashboard.
The last date that the IMB status was updated. See imbStatus for more details.
imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.
The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.
The HTML content for the inside of the snap pack, when provided instead of a template or PDF.
The template ID for the inside of the snap pack, when provided instead of HTML or PDF.
These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.
The HTML content for the outside of the snap pack, when provided instead of a template or PDF.
The template ID for the outside of the snap pack, when provided instead of HTML or PDF.
The tracking number of this order. Populated after an express/certified order has been processed for delivery.
A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied.
PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.
This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.
Print MailTargeted List Builds
Beta: the targeted list builds API is in beta and is subject to breaking changes. Endpoint shapes, status values, and filter fields may change without notice.
The targeted list builds API lets you programmatically build mailing lists of US consumers (B2C) or US companies (B2B) that match a set of demographic, geographic, and firmographic filters.
The lifecycle of a list build is:
- Create a list build by supplying either
usConsumersorusCompaniesfilters. A quote is generated asynchronously — poll the resource or wait for itsstatusto becomequote_ready. - Review the
quote(total count and price per contact) and maskedpreviewRecords. Adjust the filters with an update call if needed — this will regenerate the quote. - Confirm the build. This deducts the appropriate amount of list build
credits from your organization (in live mode) and begins constructing
the mailing list.
buildProgressPercentreflects progress from 0 to 100. - Once
statusiscompleted, the ID of the resulting mailing list is available in themailingListfield and can be used like any other mailing list in the PostGrid API.
Targeted list builds must be enabled on your organization before they can be used. Contact PostGrid support to request access.
Create Targeted List Build
List Targeted List Builds
Get Targeted List Build
Update Targeted List Build
Delete Targeted List Build
Confirm Targeted List Build
ModelsExpand Collapse
class TargetedListBuildCreateResponse: …A targeted list build represents a request to build a new mailing list by
targeting US consumers or companies matching the provided filters. Once
created, a quote is generated asynchronously. After reviewing the quote
and preview records, you may confirm the build, which kicks off the
creation of the underlying mailing list.
A targeted list build represents a request to build a new mailing list by targeting US consumers or companies matching the provided filters. Once created, a quote is generated asynchronously. After reviewing the quote and preview records, you may confirm the build, which kicks off the creation of the underlying mailing list.
status: Literal["generating_quote", "quote_ready", "creating_list", 2 more]Status of a targeted list build.
Status of a targeted list build.
A percentage from 0 to 100 representing how much of the build has
completed. Only populated while status is creating_list.
The UTC time at which the build finished successfully. Only present
once status is completed.
The UTC time at which the build was confirmed, if any.
An optional string describing this resource. Will be visible in the API and the dashboard.
Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.
The ID of the mailing list that was built. Present once status is
completed.
preview_records: Optional[List[PreviewRecord]]A small number of masked sample records for the configured filters,
populated alongside quote.
A small number of masked sample records for the configured filters,
populated alongside quote.
quote: Optional[Quote]Details of the quote generated for a targeted list build.
Details of the quote generated for a targeted list build.
us_companies: Optional[UsCompanies]Filters used to target US companies (B2B) when building a list.
Filters used to target US companies (B2B) when building a list.
company_types: Optional[List[Literal["public", "private", "educational", 3 more]]]Filter by ownership structure of the company.
Filter by ownership structure of the company.
Inclusive [min, max] range for the number of employees at the
company. Values must be between 1 and 1,000,000.
Inclusive [min, max] range for the year the company was founded.
Values must be between 1600 and 2100.
Filter by six-digit NAICS industry codes.
us_consumers: Optional[UsConsumers]Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
education_levels: Optional[List[Literal["high_school", "college", "grad_school", "vocational_training"]]]Filter by highest level of education completed.
Filter by highest level of education completed.
Inclusive [min, max] home value range, in US dollars. Values must be
between 0 and 1,000,000.
Inclusive [min, max] annual household income range, in US dollars.
Values must be between 0 and 200,000.
Inclusive [min, max] number of children in the household. Values must
be between 0 and 8.
occupations: Optional[List[Literal["professional_technical", "administration_management", "sales_service", 23 more]]]Filter by occupation classification.
Filter by occupation classification.
class TargetedListBuildListResponse: …A targeted list build represents a request to build a new mailing list by
targeting US consumers or companies matching the provided filters. Once
created, a quote is generated asynchronously. After reviewing the quote
and preview records, you may confirm the build, which kicks off the
creation of the underlying mailing list.
A targeted list build represents a request to build a new mailing list by targeting US consumers or companies matching the provided filters. Once created, a quote is generated asynchronously. After reviewing the quote and preview records, you may confirm the build, which kicks off the creation of the underlying mailing list.
status: Literal["generating_quote", "quote_ready", "creating_list", 2 more]Status of a targeted list build.
Status of a targeted list build.
A percentage from 0 to 100 representing how much of the build has
completed. Only populated while status is creating_list.
The UTC time at which the build finished successfully. Only present
once status is completed.
The UTC time at which the build was confirmed, if any.
An optional string describing this resource. Will be visible in the API and the dashboard.
Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.
The ID of the mailing list that was built. Present once status is
completed.
preview_records: Optional[List[PreviewRecord]]A small number of masked sample records for the configured filters,
populated alongside quote.
A small number of masked sample records for the configured filters,
populated alongside quote.
quote: Optional[Quote]Details of the quote generated for a targeted list build.
Details of the quote generated for a targeted list build.
us_companies: Optional[UsCompanies]Filters used to target US companies (B2B) when building a list.
Filters used to target US companies (B2B) when building a list.
company_types: Optional[List[Literal["public", "private", "educational", 3 more]]]Filter by ownership structure of the company.
Filter by ownership structure of the company.
Inclusive [min, max] range for the number of employees at the
company. Values must be between 1 and 1,000,000.
Inclusive [min, max] range for the year the company was founded.
Values must be between 1600 and 2100.
Filter by six-digit NAICS industry codes.
us_consumers: Optional[UsConsumers]Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
education_levels: Optional[List[Literal["high_school", "college", "grad_school", "vocational_training"]]]Filter by highest level of education completed.
Filter by highest level of education completed.
Inclusive [min, max] home value range, in US dollars. Values must be
between 0 and 1,000,000.
Inclusive [min, max] annual household income range, in US dollars.
Values must be between 0 and 200,000.
Inclusive [min, max] number of children in the household. Values must
be between 0 and 8.
occupations: Optional[List[Literal["professional_technical", "administration_management", "sales_service", 23 more]]]Filter by occupation classification.
Filter by occupation classification.
class TargetedListBuildRetrieveResponse: …A targeted list build represents a request to build a new mailing list by
targeting US consumers or companies matching the provided filters. Once
created, a quote is generated asynchronously. After reviewing the quote
and preview records, you may confirm the build, which kicks off the
creation of the underlying mailing list.
A targeted list build represents a request to build a new mailing list by targeting US consumers or companies matching the provided filters. Once created, a quote is generated asynchronously. After reviewing the quote and preview records, you may confirm the build, which kicks off the creation of the underlying mailing list.
status: Literal["generating_quote", "quote_ready", "creating_list", 2 more]Status of a targeted list build.
Status of a targeted list build.
A percentage from 0 to 100 representing how much of the build has
completed. Only populated while status is creating_list.
The UTC time at which the build finished successfully. Only present
once status is completed.
The UTC time at which the build was confirmed, if any.
An optional string describing this resource. Will be visible in the API and the dashboard.
Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.
The ID of the mailing list that was built. Present once status is
completed.
preview_records: Optional[List[PreviewRecord]]A small number of masked sample records for the configured filters,
populated alongside quote.
A small number of masked sample records for the configured filters,
populated alongside quote.
quote: Optional[Quote]Details of the quote generated for a targeted list build.
Details of the quote generated for a targeted list build.
us_companies: Optional[UsCompanies]Filters used to target US companies (B2B) when building a list.
Filters used to target US companies (B2B) when building a list.
company_types: Optional[List[Literal["public", "private", "educational", 3 more]]]Filter by ownership structure of the company.
Filter by ownership structure of the company.
Inclusive [min, max] range for the number of employees at the
company. Values must be between 1 and 1,000,000.
Inclusive [min, max] range for the year the company was founded.
Values must be between 1600 and 2100.
Filter by six-digit NAICS industry codes.
us_consumers: Optional[UsConsumers]Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
education_levels: Optional[List[Literal["high_school", "college", "grad_school", "vocational_training"]]]Filter by highest level of education completed.
Filter by highest level of education completed.
Inclusive [min, max] home value range, in US dollars. Values must be
between 0 and 1,000,000.
Inclusive [min, max] annual household income range, in US dollars.
Values must be between 0 and 200,000.
Inclusive [min, max] number of children in the household. Values must
be between 0 and 8.
occupations: Optional[List[Literal["professional_technical", "administration_management", "sales_service", 23 more]]]Filter by occupation classification.
Filter by occupation classification.
class TargetedListBuildUpdateResponse: …A targeted list build represents a request to build a new mailing list by
targeting US consumers or companies matching the provided filters. Once
created, a quote is generated asynchronously. After reviewing the quote
and preview records, you may confirm the build, which kicks off the
creation of the underlying mailing list.
A targeted list build represents a request to build a new mailing list by targeting US consumers or companies matching the provided filters. Once created, a quote is generated asynchronously. After reviewing the quote and preview records, you may confirm the build, which kicks off the creation of the underlying mailing list.
status: Literal["generating_quote", "quote_ready", "creating_list", 2 more]Status of a targeted list build.
Status of a targeted list build.
A percentage from 0 to 100 representing how much of the build has
completed. Only populated while status is creating_list.
The UTC time at which the build finished successfully. Only present
once status is completed.
The UTC time at which the build was confirmed, if any.
An optional string describing this resource. Will be visible in the API and the dashboard.
Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.
The ID of the mailing list that was built. Present once status is
completed.
preview_records: Optional[List[PreviewRecord]]A small number of masked sample records for the configured filters,
populated alongside quote.
A small number of masked sample records for the configured filters,
populated alongside quote.
quote: Optional[Quote]Details of the quote generated for a targeted list build.
Details of the quote generated for a targeted list build.
us_companies: Optional[UsCompanies]Filters used to target US companies (B2B) when building a list.
Filters used to target US companies (B2B) when building a list.
company_types: Optional[List[Literal["public", "private", "educational", 3 more]]]Filter by ownership structure of the company.
Filter by ownership structure of the company.
Inclusive [min, max] range for the number of employees at the
company. Values must be between 1 and 1,000,000.
Inclusive [min, max] range for the year the company was founded.
Values must be between 1600 and 2100.
Filter by six-digit NAICS industry codes.
us_consumers: Optional[UsConsumers]Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
education_levels: Optional[List[Literal["high_school", "college", "grad_school", "vocational_training"]]]Filter by highest level of education completed.
Filter by highest level of education completed.
Inclusive [min, max] home value range, in US dollars. Values must be
between 0 and 1,000,000.
Inclusive [min, max] annual household income range, in US dollars.
Values must be between 0 and 200,000.
Inclusive [min, max] number of children in the household. Values must
be between 0 and 8.
occupations: Optional[List[Literal["professional_technical", "administration_management", "sales_service", 23 more]]]Filter by occupation classification.
Filter by occupation classification.
class TargetedListBuildConfirmResponse: …A targeted list build represents a request to build a new mailing list by
targeting US consumers or companies matching the provided filters. Once
created, a quote is generated asynchronously. After reviewing the quote
and preview records, you may confirm the build, which kicks off the
creation of the underlying mailing list.
A targeted list build represents a request to build a new mailing list by targeting US consumers or companies matching the provided filters. Once created, a quote is generated asynchronously. After reviewing the quote and preview records, you may confirm the build, which kicks off the creation of the underlying mailing list.
status: Literal["generating_quote", "quote_ready", "creating_list", 2 more]Status of a targeted list build.
Status of a targeted list build.
A percentage from 0 to 100 representing how much of the build has
completed. Only populated while status is creating_list.
The UTC time at which the build finished successfully. Only present
once status is completed.
The UTC time at which the build was confirmed, if any.
An optional string describing this resource. Will be visible in the API and the dashboard.
Maximum number of contacts to include in the built mailing list. If omitted, all matching contacts are included.
The ID of the mailing list that was built. Present once status is
completed.
preview_records: Optional[List[PreviewRecord]]A small number of masked sample records for the configured filters,
populated alongside quote.
A small number of masked sample records for the configured filters,
populated alongside quote.
quote: Optional[Quote]Details of the quote generated for a targeted list build.
Details of the quote generated for a targeted list build.
us_companies: Optional[UsCompanies]Filters used to target US companies (B2B) when building a list.
Filters used to target US companies (B2B) when building a list.
company_types: Optional[List[Literal["public", "private", "educational", 3 more]]]Filter by ownership structure of the company.
Filter by ownership structure of the company.
Inclusive [min, max] range for the number of employees at the
company. Values must be between 1 and 1,000,000.
Inclusive [min, max] range for the year the company was founded.
Values must be between 1600 and 2100.
Filter by six-digit NAICS industry codes.
us_consumers: Optional[UsConsumers]Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
Filters used to target US consumers (B2C) when building a list.
The geographic filters (zipCodesAround, cityStates, zipCodes) are
mutually exclusive — you may supply at most one of them.
education_levels: Optional[List[Literal["high_school", "college", "grad_school", "vocational_training"]]]Filter by highest level of education completed.
Filter by highest level of education completed.
Inclusive [min, max] home value range, in US dollars. Values must be
between 0 and 1,000,000.
Inclusive [min, max] annual household income range, in US dollars.
Values must be between 0 and 200,000.
Inclusive [min, max] number of children in the household. Values must
be between 0 and 8.
occupations: Optional[List[Literal["professional_technical", "administration_management", "sales_service", 23 more]]]Filter by occupation classification.
Filter by occupation classification.
Print MailTargeted List BuildsFilters
Beta: the targeted list builds API is in beta and is subject to breaking changes. Endpoint shapes, status values, and filter fields may change without notice.
The targeted list builds API lets you programmatically build mailing lists of US consumers (B2C) or US companies (B2B) that match a set of demographic, geographic, and firmographic filters.
The lifecycle of a list build is:
- Create a list build by supplying either
usConsumersorusCompaniesfilters. A quote is generated asynchronously — poll the resource or wait for itsstatusto becomequote_ready. - Review the
quote(total count and price per contact) and maskedpreviewRecords. Adjust the filters with an update call if needed — this will regenerate the quote. - Confirm the build. This deducts the appropriate amount of list build
credits from your organization (in live mode) and begins constructing
the mailing list.
buildProgressPercentreflects progress from 0 to 100. - Once
statusiscompleted, the ID of the resulting mailing list is available in themailingListfield and can be used like any other mailing list in the PostGrid API.
Targeted list builds must be enabled on your organization before they can be used. Contact PostGrid support to request access.
Autocomplete Filter Values
ModelsExpand Collapse
Print MailTemplate Editor Sessions
You can use template editor sessions to bring the capabilities of our
template editor to your website. When you create a session, you provide the
template which you want to edit, and we return a session with a url that
you can iframe or redirect your customers to.
When users save their changes in the editor session, it will update the underlying template. Note that sessions are only valid for 24 hours, after which point they are automatically deleted for security reasons.
You can have multiple sessions active for the same template at the same time. In general, we recommend creating a new session every time you present our editor to your users.
Note: you can use the template editor to modify templates created using HTML, but saving a session from the editor will override the original HTML content.
Create Session
List Sessions
Delete Session
ModelsExpand Collapse
Print MailVirtual Mailboxes
Virtual mailboxes let you receive, scan, and forward your physical mail without needing a traditional physical mailbox. Each mailbox is fully digital, giving you a unique ID, status, and a set of capabilities such as forwarding mail to another address or viewing envelope scans. This allows you to manage physical correspondence entirely online.
You can request access to this feature by reaching out to support@postgrid.com
Create Virtual Mailbox
List Virtual Mailboxes
Retrieve Virtual Mailbox
Retrieve Physical Address
ModelsExpand Collapse
class VirtualMailboxCreateResponse: …The virtual mailbox object.
The virtual mailbox object.
capabilities: CapabilitiesAll of the capabilities a virtual mailbox may have.
All of the capabilities a virtual mailbox may have.
forward_mail_to: Optional[Contact]A contact to forward any returned mail to.
A contact to forward any returned mail to.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
class VirtualMailboxListResponse: …The virtual mailbox object.
The virtual mailbox object.
capabilities: CapabilitiesAll of the capabilities a virtual mailbox may have.
All of the capabilities a virtual mailbox may have.
forward_mail_to: Optional[Contact]A contact to forward any returned mail to.
A contact to forward any returned mail to.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
class VirtualMailboxRetrieveResponse: …The virtual mailbox object.
The virtual mailbox object.
capabilities: CapabilitiesAll of the capabilities a virtual mailbox may have.
All of the capabilities a virtual mailbox may have.
forward_mail_to: Optional[Contact]A contact to forward any returned mail to.
A contact to forward any returned mail to.
A series of human-readable errors/warnings that were raised when running the provided address through our address verification.
An optional string describing this resource. Will be visible in the API and the dashboard.
Print MailVirtual MailboxesItems
Virtual mailboxes let you receive, scan, and forward your physical mail without needing a traditional physical mailbox. Each mailbox is fully digital, giving you a unique ID, status, and a set of capabilities such as forwarding mail to another address or viewing envelope scans. This allows you to manage physical correspondence entirely online.
You can request access to this feature by reaching out to support@postgrid.com