API Reference

Print Mail

Letters

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Letter Create Letter

print_mail.letters.create(LetterCreateParams**kwargs) -> LetterCreateResponse

POST/print-mail/v1/letters

Create a letter. Note that you can supply one of the following:

• HTML content for the letter
• A template ID for the letter
• A URL for a PDF for the letter Create a letter via a multipart/form-data request. Accepts the same fields as the JSON create body (nested objects are bracket-encoded form fields, e.g. to[firstName]); use this content type to upload the PDF file directly.

ParametersExpand Collapse

from_: LetterCreateWithHTMLFrom

The contact information of the sender. You can pass contact information inline here just like you can for the to.

One of the following:

class ContactCreateWithFirstName: …

address_line1: str

The first line of the contact’s address.

country_code: str

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

first_name: str

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

class ContactCreateWithCompanyName: …

address_line1: str

The first line of the contact’s address.

company_name: str

country_code: str

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

str

html: str

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

to: LetterCreateWithHTMLTo

The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.

One of the following:

class ContactCreateWithFirstName: …

address_line1: str

The first line of the contact’s address.

country_code: str

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

first_name: str

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

class ContactCreateWithCompanyName: …

address_line1: str

The first line of the contact’s address.

company_name: str

country_code: str

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

str

address_placement: Optional[AddressPlacement]

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

attached_pdf: Optional[AttachedPdfParam]

Model representing an attached PDF.

file: Union[str, object]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

placement: Literal["before_template", "after_template"]

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

color: Optional[bool]

Indicates if the letter is in color.

description: Optional[str]

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

double_sided: Optional[bool]

Indicates if the letter is double-sided.

envelope: Optional[str]

The envelope (ID) for the letter. You can either specify a custom envelope ID or use the default standard envelope.

mailing_class: Optional[Literal["first_class", "standard_class", "express", 23 more]]

The mailing class of this order. If not provided, automatically set to first_class.

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"

merge_variables: Optional[Dict[str, object]]

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: Optional[Dict[str, object]]

See the section on Metadata.

paper: Optional[Union[Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"], str]]

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:

Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"]

Built-in paper IDs for letter products. Actual availability depends on your organization settings.

One of the following:

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

str

Premium paper identifier.

standard is always accepted. Organizations may also have additional custom premium_paper_* IDs beyond the built-in values documented here.

perforated_page: Optional[Literal[1]]

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

plastic_card: Optional[PlasticCardParam]

Model representing a plastic card.

size: Literal["standard"]

Enum representing the size of the plastic card.

double_sided: Optional[DoubleSided]

Model representing a double-sided plastic card.

back_html: Optional[str]

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

back_template: Optional[str]

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

front_html: Optional[str]

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

front_template: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

single_sided: Optional[SingleSided]

Model representing a single-sided plastic card.

html: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

template: Optional[str]

The template ID for the single-sided plastic card.

return_envelope: Optional[str]

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

send_date: Optional[Union[str, datetime]]

This order will transition from ready to printing on the day after this date. You can use this parameter to schedule orders for a future date.

formatdate-time

size: Optional[LetterSize]

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

idempotency_key: Optional[str]

ReturnsExpand Collapse

LetterCreateResponse

One of the following:

class Letter: …

id: str

A unique ID prefixed with letter_

address_placement: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

color: bool

Indicates if the letter is in color.

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

double_sided: bool

Indicates if the letter is double-sided.

envelope: str

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

from_: Contact

The contact information of the sender.

id: str

A unique ID prefixed with contact_

address_line1: str

The first line of the contact’s address.

address_status: Literal["verified", "corrected", "failed"]

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

country_code: str

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

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

object: Literal["contact"]

Always contact.

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

address_errors: Optional[str]

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

live: bool

true if this is a live mode resource else false.

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.

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: Literal["letter"]

Always letter.

send_date: datetime

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: Literal["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

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

id: str

A unique ID prefixed with contact_

address_line1: str

The first line of the contact’s address.

address_status: Literal["verified", "corrected", "failed"]

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

country_code: str

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

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

object: Literal["contact"]

Always contact.

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

address_errors: Optional[str]

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

attached_pdf: Optional[AttachedPdf]

Model representing an attached PDF.

file: Union[str, object]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

placement: Literal["before_template", "after_template"]

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

cancellation: Optional[Cancellation]

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

reason: Literal["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"

cancelled_by_user: Optional[str]

The user ID who cancelled the order.

note: Optional[str]

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

description: Optional[str]

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

html: Optional[str]

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

imb_date: Optional[datetime]

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

formatdate-time

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.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imb_zip_code: Optional[str]

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

merge_variables: Optional[Dict[str, object]]

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: Optional[Dict[str, object]]

See the section on Metadata.

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:

• 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:

Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"]

Built-in paper IDs for letter products. Actual availability depends on your organization settings.

One of the following:

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

str

Premium paper identifier.

standard is always accepted. Organizations may also have additional custom premium_paper_* IDs beyond the built-in values documented here.

pdf_workflow_run: Optional[str]

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

perforated_page: Optional[Literal[1]]

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.

size: Literal["standard"]

Enum representing the size of the plastic card.

double_sided: Optional[DoubleSided]

Model representing a double-sided plastic card.

back_html: Optional[str]

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

back_template: Optional[str]

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

front_html: Optional[str]

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

front_template: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

single_sided: Optional[SingleSided]

Model representing a single-sided plastic card.

html: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

template: Optional[str]

The template ID for the single-sided plastic card.

return_envelope: Optional[str]

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

template: Optional[str]

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

tracking_number: Optional[str]

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

uploaded_pdf: Optional[str]

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

formaturi

url: Optional[str]

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

class Letter: …

id: str

A unique ID prefixed with letter_

address_placement: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

color: bool

Indicates if the letter is in color.

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

double_sided: bool

Indicates if the letter is double-sided.

envelope: str

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

from_: Contact

The contact information of the sender.

id: str

A unique ID prefixed with contact_

address_line1: str

The first line of the contact’s address.

address_status: Literal["verified", "corrected", "failed"]

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

country_code: str

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

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

object: Literal["contact"]

Always contact.

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

address_errors: Optional[str]

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

live: bool

true if this is a live mode resource else false.

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.

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: Literal["letter"]

Always letter.

send_date: datetime

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: Literal["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

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

id: str

A unique ID prefixed with contact_

address_line1: str

The first line of the contact’s address.

address_status: Literal["verified", "corrected", "failed"]

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

country_code: str

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

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

object: Literal["contact"]

Always contact.

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

address_errors: Optional[str]

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

address_line2: Optional[str]

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

city: Optional[str]

The city of the contact’s address.

company_name: Optional[str]

Company name of the contact.

description: Optional[str]

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

email: Optional[str]

Email of the contact.

first_name: Optional[str]

First name of the contact.

force_verified_status: Optional[bool]

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

job_title: Optional[str]

Job title of the contact.

last_name: Optional[str]

Last name of the contact.

metadata: Optional[Dict[str, object]]

See the section on Metadata.

phone_number: Optional[str]

Phone number of the contact.

postal_or_zip: Optional[str]

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

province_or_state: Optional[str]

Province or state of the contact’s address.

secret: Optional[bool]

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.

skip_verification: Optional[bool]

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

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

attached_pdf: Optional[AttachedPdf]

Model representing an attached PDF.

file: Union[str, object]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

placement: Literal["before_template", "after_template"]

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

cancellation: Optional[Cancellation]

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

reason: Literal["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"

cancelled_by_user: Optional[str]

The user ID who cancelled the order.

note: Optional[str]

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

description: Optional[str]

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

html: Optional[str]

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

imb_date: Optional[datetime]

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

formatdate-time

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.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imb_zip_code: Optional[str]

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

merge_variables: Optional[Dict[str, object]]

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: Optional[Dict[str, object]]

See the section on Metadata.

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:

• 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:

Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"]

Built-in paper IDs for letter products. Actual availability depends on your organization settings.

One of the following:

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

str

Premium paper identifier.

standard is always accepted. Organizations may also have additional custom premium_paper_* IDs beyond the built-in values documented here.

pdf_workflow_run: Optional[str]

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

perforated_page: Optional[Literal[1]]

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.

size: Literal["standard"]

Enum representing the size of the plastic card.

double_sided: Optional[DoubleSided]

Model representing a double-sided plastic card.

back_html: Optional[str]

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

back_template: Optional[str]

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

front_html: Optional[str]

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

front_template: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

single_sided: Optional[SingleSided]

Model representing a single-sided plastic card.

html: Optional[str]

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

pdf: Optional[Union[str, object, null]]

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

One of the following:

str

object

Represents a raw file upload. Sending the actual file requires a multipart/form-data request; in application/json request bodies, supply a URL instead.

template: Optional[str]

The template ID for the single-sided plastic card.

return_envelope: Optional[str]

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

template: Optional[str]

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

tracking_number: Optional[str]

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

uploaded_pdf: Optional[str]

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

formaturi

url: Optional[str]

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

Create Letter Create Letter

Python

HTTP

TypeScript

Python

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
letter = client.print_mail.letters.create(
    from_="contact_123",
    html="<html>Content</html>",
    to="contact_123",
    paper="standard",
)
print(letter)

200 example

{
  "id": "letter_sqF12lZ1VlBb",
  "addressPlacement": "top_first_page",
  "color": true,
  "createdAt": "2019-12-27T18:11:19.117Z",
  "doubleSided": true,
  "envelope": "envelope",
  "from": {
    "id": "contact_sqF12lZ1VlBb",
    "addressLine1": "addressLine1",
    "addressStatus": "verified",
    "countryCode": "countryCode",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "live": true,
    "object": "contact",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "addressErrors": "addressErrors",
    "addressLine2": "addressLine2",
    "city": "city",
    "companyName": "companyName",
    "description": "description",
    "email": "email",
    "firstName": "firstName",
    "forceVerifiedStatus": true,
    "jobTitle": "jobTitle",
    "lastName": "lastName",
    "metadata": {
      "foo": "bar"
    },
    "phoneNumber": "phoneNumber",
    "postalOrZip": "postalOrZip",
    "provinceOrState": "provinceOrState",
    "secret": true,
    "skipVerification": true
  },
  "live": true,
  "mailingClass": "first_class",
  "object": "letter",
  "sendDate": "2019-12-27T18:11:19.117Z",
  "size": "us_letter",
  "status": "ready",
  "to": {
    "id": "contact_sqF12lZ1VlBb",
    "addressLine1": "addressLine1",
    "addressStatus": "verified",
    "countryCode": "countryCode",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "live": true,
    "object": "contact",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "addressErrors": "addressErrors",
    "addressLine2": "addressLine2",
    "city": "city",
    "companyName": "companyName",
    "description": "description",
    "email": "email",
    "firstName": "firstName",
    "forceVerifiedStatus": true,
    "jobTitle": "jobTitle",
    "lastName": "lastName",
    "metadata": {
      "foo": "bar"
    },
    "phoneNumber": "phoneNumber",
    "postalOrZip": "postalOrZip",
    "provinceOrState": "provinceOrState",
    "secret": true,
    "skipVerification": true
  },
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "attachedPDF": {
    "file": "https://example.com",
    "placement": "before_template"
  },
  "cancellation": {
    "reason": "user_initiated",
    "cancelledByUser": "cancelledByUser",
    "note": "note"
  },
  "description": "description",
  "html": "html",
  "imbDate": "2019-12-27T18:11:19.117Z",
  "imbStatus": "entered_mail_stream",
  "imbZIPCode": "imbZIPCode",
  "mergeVariables": {
    "foo": "bar"
  },
  "metadata": {
    "foo": "bar"
  },
  "paper": "standard",
  "pdfWorkflowRun": "pdfWorkflowRun",
  "perforatedPage": 1,
  "plasticCard": {
    "size": "standard",
    "doubleSided": {
      "backHTML": "backHTML",
      "backTemplate": "backTemplate",
      "frontHTML": "frontHTML",
      "frontTemplate": "frontTemplate",
      "pdf": "https://example.com"
    },
    "singleSided": {
      "html": "html",
      "pdf": "https://example.com",
      "template": "template"
    }
  },
  "returnEnvelope": "returnEnvelope",
  "template": "template",
  "trackingNumber": "trackingNumber",
  "uploadedPDF": "https://example.com",
  "url": "https://example.com"
}

Returns Examples

200 example

{
  "id": "letter_sqF12lZ1VlBb",
  "addressPlacement": "top_first_page",
  "color": true,
  "createdAt": "2019-12-27T18:11:19.117Z",
  "doubleSided": true,
  "envelope": "envelope",
  "from": {
    "id": "contact_sqF12lZ1VlBb",
    "addressLine1": "addressLine1",
    "addressStatus": "verified",
    "countryCode": "countryCode",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "live": true,
    "object": "contact",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "addressErrors": "addressErrors",
    "addressLine2": "addressLine2",
    "city": "city",
    "companyName": "companyName",
    "description": "description",
    "email": "email",
    "firstName": "firstName",
    "forceVerifiedStatus": true,
    "jobTitle": "jobTitle",
    "lastName": "lastName",
    "metadata": {
      "foo": "bar"
    },
    "phoneNumber": "phoneNumber",
    "postalOrZip": "postalOrZip",
    "provinceOrState": "provinceOrState",
    "secret": true,
    "skipVerification": true
  },
  "live": true,
  "mailingClass": "first_class",
  "object": "letter",
  "sendDate": "2019-12-27T18:11:19.117Z",
  "size": "us_letter",
  "status": "ready",
  "to": {
    "id": "contact_sqF12lZ1VlBb",
    "addressLine1": "addressLine1",
    "addressStatus": "verified",
    "countryCode": "countryCode",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "live": true,
    "object": "contact",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "addressErrors": "addressErrors",
    "addressLine2": "addressLine2",
    "city": "city",
    "companyName": "companyName",
    "description": "description",
    "email": "email",
    "firstName": "firstName",
    "forceVerifiedStatus": true,
    "jobTitle": "jobTitle",
    "lastName": "lastName",
    "metadata": {
      "foo": "bar"
    },
    "phoneNumber": "phoneNumber",
    "postalOrZip": "postalOrZip",
    "provinceOrState": "provinceOrState",
    "secret": true,
    "skipVerification": true
  },
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "attachedPDF": {
    "file": "https://example.com",
    "placement": "before_template"
  },
  "cancellation": {
    "reason": "user_initiated",
    "cancelledByUser": "cancelledByUser",
    "note": "note"
  },
  "description": "description",
  "html": "html",
  "imbDate": "2019-12-27T18:11:19.117Z",
  "imbStatus": "entered_mail_stream",
  "imbZIPCode": "imbZIPCode",
  "mergeVariables": {
    "foo": "bar"
  },
  "metadata": {
    "foo": "bar"
  },
  "paper": "standard",
  "pdfWorkflowRun": "pdfWorkflowRun",
  "perforatedPage": 1,
  "plasticCard": {
    "size": "standard",
    "doubleSided": {
      "backHTML": "backHTML",
      "backTemplate": "backTemplate",
      "frontHTML": "frontHTML",
      "frontTemplate": "frontTemplate",
      "pdf": "https://example.com"
    },
    "singleSided": {
      "html": "html",
      "pdf": "https://example.com",
      "template": "template"
    }
  },
  "returnEnvelope": "returnEnvelope",
  "template": "template",
  "trackingNumber": "trackingNumber",
  "uploadedPDF": "https://example.com",
  "url": "https://example.com"
}