Letters

Create and manage letter orders.

Create Letter Create Letter

client.printMail.letters.create(, ?): LetterCreateResponse

POST/print-mail/v1/letters

List Letters

client.printMail.letters.list(?, ?): SkipLimit<Letter { id, addressPlacement, color, 30 more } >

GET/print-mail/v1/letters

Get Letter

client.printMail.letters.retrieve(, ?): Letter { id, addressPlacement, color, 30 more }

GET/print-mail/v1/letters/{id}

Cancel Letter

client.printMail.letters.delete(, ?): Letter { id, addressPlacement, color, 30 more }

DELETE/print-mail/v1/letters/{id}

Get Letter Preview

client.printMail.letters.retrieveURL(, ?): LetterRetrieveURLResponse { id, object, url }

GET/print-mail/v1/letters/{id}/url

Cancel Letter With Note

client.printMail.letters.cancel(, , ?): Letter { id, addressPlacement, color, 30 more }

POST/print-mail/v1/letters/{id}/cancellation

Progress Status

client.printMail.letters.progress(, ?): Letter { id, addressPlacement, color, 30 more }

POST/print-mail/v1/letters/{id}/progressions

ModelsExpand Collapse

AddressPlacement = "top_first_page" | "insert_blank_page"

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

AttachedPdf { file, placement }

Model representing an attached PDF.

file: string | Uploadable

The file (multipart form upload) or URL pointing to a PDF for the attached PDF.

One of the following:

string

Uploadable

placement: "before_template" | "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

Letter { id, addressPlacement, color, 30 more }

id: string

A unique ID prefixed with letter_

addressPlacement: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

color: boolean

Indicates if the letter is in color.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

doubleSided: boolean

Indicates if the letter is double-sided.

envelope: string

The envelope (ID) for the letter or the default standard envelope.

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact information of the sender.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "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.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "letter"

Always letter.

sendDate: string

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.

formatdate-time

size: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

attachedPDF?: AttachedPdf { file, placement }

Model representing an attached PDF.

file: string | Uploadable

The file (multipart form upload) or URL pointing to a PDF for the attached PDF.

One of the following:

string

Uploadable

placement: "before_template" | "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

html?: string

The HTML content for the letter. You can supply either this or template but not both.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "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.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

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.

metadata?: Record<string, unknown>

See the section on Metadata.

paper?: "standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb" | (string & {})

Premium paper selection used for this letter.

Available values include:

standard
premium_paper_letter_standard_white_70lb
premium_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.

One of the following:

"standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb"

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

(string & {})

pdfWorkflowRun?: string

The ID of the PDF workflow run that created the letter, if any.

perforatedPage?: 1

If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.

plasticCard?: PlasticCard { size, doubleSided, singleSided }

Model representing a plastic card.

size: "standard"

Enum representing the size of the plastic card.

doubleSided?: DoubleSided { backHTML, backTemplate, frontHTML, 2 more }

Model representing a double-sided plastic card.

backHTML?: string

The HTML content for the back side of the double-sided plastic card.

backTemplate?: string

The template ID for the back side of the double-sided plastic card.

frontHTML?: string

The HTML content for the front side of the double-sided plastic card.

frontTemplate?: string

The template ID for the front side of the double-sided plastic card.

pdf?: string | Uploadable

A URL pointing to a PDF file for the double-sided plastic card or the file itself.

One of the following:

string

Uploadable

singleSided?: SingleSided { html, pdf, template }

Model representing a single-sided plastic card.

html?: string

The HTML content for the single-sided plastic card. Can specify one of this, template, or pdf.

pdf?: string | Uploadable

A URL pointing to a PDF file for the single-sided plastic card or the PDF file itself.

One of the following:

string

Uploadable

template?: string

The template ID for the single-sided plastic card.

returnEnvelope?: string

The return envelope (ID) sent out with the letter, if any.

template?: string

The template ID used for the letter. You can supply either this or html but not both.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

uploadedPDF?: string

If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF.

formaturi

url?: string

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.

formaturi

LetterSize = "us_letter" | "a4"

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

PlasticCard { size, doubleSided, singleSided }

Model representing a plastic card.

size: "standard"

Enum representing the size of the plastic card.

doubleSided?: DoubleSided { backHTML, backTemplate, frontHTML, 2 more }

Model representing a double-sided plastic card.

backHTML?: string

The HTML content for the back side of the double-sided plastic card.

backTemplate?: string

The template ID for the back side of the double-sided plastic card.

frontHTML?: string

The HTML content for the front side of the double-sided plastic card.

frontTemplate?: string

The template ID for the front side of the double-sided plastic card.

pdf?: string | Uploadable

A URL pointing to a PDF file for the double-sided plastic card or the file itself.

One of the following:

string

Uploadable

singleSided?: SingleSided { html, pdf, template }

Model representing a single-sided plastic card.

html?: string

The HTML content for the single-sided plastic card. Can specify one of this, template, or pdf.

pdf?: string | Uploadable

A URL pointing to a PDF file for the single-sided plastic card or the PDF file itself.

One of the following:

string

Uploadable

template?: string

The template ID for the single-sided plastic card.

LetterCreateResponse = Letter { id, addressPlacement, color, 30 more } | Letter { id, addressPlacement, color, 30 more }

One of the following:

Letter { id, addressPlacement, color, 30 more }

id: string

A unique ID prefixed with letter_

addressPlacement: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

color: boolean

Indicates if the letter is in color.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

doubleSided: boolean

Indicates if the letter is double-sided.

envelope: string

The envelope (ID) for the letter or the default standard envelope.

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact information of the sender.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "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.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "letter"

Always letter.

sendDate: string

formatdate-time

size: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

attachedPDF?: AttachedPdf { file, placement }

Model representing an attached PDF.

file: string | Uploadable

The file (multipart form upload) or URL pointing to a PDF for the attached PDF.

One of the following:

string

Uploadable

placement: "before_template" | "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

html?: string

The HTML content for the letter. You can supply either this or template but not both.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "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.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

metadata?: Record<string, unknown>

See the section on Metadata.

paper?: "standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb" | (string & {})

Premium paper selection used for this letter.

Available values include:

standard
premium_paper_letter_standard_white_70lb
premium_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.

One of the following:

"standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb"

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

(string & {})

pdfWorkflowRun?: string

The ID of the PDF workflow run that created the letter, if any.

perforatedPage?: 1

If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.

plasticCard?: PlasticCard { size, doubleSided, singleSided }

Model representing a plastic card.

size: "standard"

Enum representing the size of the plastic card.

doubleSided?: DoubleSided { backHTML, backTemplate, frontHTML, 2 more }

Model representing a double-sided plastic card.

backHTML?: string

The HTML content for the back side of the double-sided plastic card.

backTemplate?: string

The template ID for the back side of the double-sided plastic card.

frontHTML?: string

The HTML content for the front side of the double-sided plastic card.

frontTemplate?: string

The template ID for the front side of the double-sided plastic card.

pdf?: string | Uploadable

A URL pointing to a PDF file for the double-sided plastic card or the file itself.

One of the following:

string

Uploadable

singleSided?: SingleSided { html, pdf, template }

Model representing a single-sided plastic card.

html?: string

The HTML content for the single-sided plastic card. Can specify one of this, template, or pdf.

pdf?: string | Uploadable

A URL pointing to a PDF file for the single-sided plastic card or the PDF file itself.

One of the following:

string

Uploadable

template?: string

The template ID for the single-sided plastic card.

returnEnvelope?: string

The return envelope (ID) sent out with the letter, if any.

template?: string

The template ID used for the letter. You can supply either this or html but not both.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

uploadedPDF?: string

If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF.

formaturi

url?: string

formaturi

Letter { id, addressPlacement, color, 30 more }

id: string

A unique ID prefixed with letter_

addressPlacement: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

color: boolean

Indicates if the letter is in color.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

doubleSided: boolean

Indicates if the letter is double-sided.

envelope: string

The envelope (ID) for the letter or the default standard envelope.

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact information of the sender.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "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.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "letter"

Always letter.

sendDate: string

formatdate-time

size: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

attachedPDF?: AttachedPdf { file, placement }

Model representing an attached PDF.

file: string | Uploadable

The file (multipart form upload) or URL pointing to a PDF for the attached PDF.

One of the following:

string

Uploadable

placement: "before_template" | "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

html?: string

The HTML content for the letter. You can supply either this or template but not both.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "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.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

metadata?: Record<string, unknown>

See the section on Metadata.

paper?: "standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb" | (string & {})

Premium paper selection used for this letter.

Available values include:

standard
premium_paper_letter_standard_white_70lb
premium_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.

One of the following:

"standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb"

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

(string & {})

pdfWorkflowRun?: string

The ID of the PDF workflow run that created the letter, if any.

perforatedPage?: 1

If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.

plasticCard?: PlasticCard { size, doubleSided, singleSided }

Model representing a plastic card.

size: "standard"

Enum representing the size of the plastic card.

doubleSided?: DoubleSided { backHTML, backTemplate, frontHTML, 2 more }

Model representing a double-sided plastic card.

backHTML?: string

The HTML content for the back side of the double-sided plastic card.

backTemplate?: string

The template ID for the back side of the double-sided plastic card.

frontHTML?: string

The HTML content for the front side of the double-sided plastic card.

frontTemplate?: string

The template ID for the front side of the double-sided plastic card.

pdf?: string | Uploadable

A URL pointing to a PDF file for the double-sided plastic card or the file itself.

One of the following:

string

Uploadable

singleSided?: SingleSided { html, pdf, template }

Model representing a single-sided plastic card.

html?: string

The HTML content for the single-sided plastic card. Can specify one of this, template, or pdf.

pdf?: string | Uploadable

A URL pointing to a PDF file for the single-sided plastic card or the PDF file itself.

One of the following:

string

Uploadable

template?: string

The template ID for the single-sided plastic card.

returnEnvelope?: string

The return envelope (ID) sent out with the letter, if any.

template?: string

The template ID used for the letter. You can supply either this or html but not both.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

uploadedPDF?: string

If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF.

formaturi

url?: string

formaturi

LetterRetrieveURLResponse { id, object, url }

id: string

A unique ID prefixed with letter_

object: string

url: string

A signed URL linking to the order preview PDF. The link remains valid for 15 minutes from the time of the API call.

formaturi