API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Return Envelopes

You can use the return envelopes API to create and manage return envelopes. These are envelopes that are sent along with your mail (if specified) and allow your recipients to send mail to a particular address without having to purchase their own envelopes/stamps.

Note that you must order return envelopes and wait for the order to be filled before you can use them. You can manage these return envelope orders via the API as well as the dashboard.

Create Return Envelope

POST/print-mail/v1/return_envelopes

List Return Envelopes

GET/print-mail/v1/return_envelopes

Get Return Envelope

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

ModelsExpand Collapse

ReturnEnvelope object { id, available, createdAt, 6 more }

id: string

A unique ID prefixed with return_envelope_

available: number

The number of return envelopes available to use in your orders immediately. This increases when a return envelope order is filled and decreases as you send orders which include this return envelope.

formatint32

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: "return_envelope"

Always return_envelope.

to: object { id, addressLine1, addressStatus, 17 more }

The contact denormalized onto a return envelope when it is created. Unlike a full contact it is not a standalone resource, so it has no object, live, createdAt, or updatedAt fields.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" or "corrected" or "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.

addressErrors: optional string

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

addressLine2: optional string

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

city: optional string

The city of the contact’s address.

companyName: optional string

Company name of the contact.

description: optional string

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

email: optional string

Email of the contact.

firstName: optional string

First name of the contact.

forceVerifiedStatus: optional boolean

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

jobTitle: optional string

Job title of the contact.

lastName: optional string

Last name of the contact.

metadata: optional map[unknown]

See the section on Metadata.

phoneNumber: optional string

Phone number of the contact.

postalOrZip: optional string

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

provinceOrState: optional string

Province or state of the contact’s address.

secret: optional 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: optional 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

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

Return EnvelopesOrders

You can use the return envelopes API to create and manage return envelopes. These are envelopes that are sent along with your mail (if specified) and allow your recipients to send mail to a particular address without having to purchase their own envelopes/stamps.

Note that you must order return envelopes and wait for the order to be filled before you can use them. You can manage these return envelope orders via the API as well as the dashboard.

Create Return Envelope Order

POST/print-mail/v1/return_envelopes/{id}/orders

List Return Envelope Orders

GET/print-mail/v1/return_envelopes/{id}/orders

Get Return Envelope Order

GET/print-mail/v1/return_envelopes/{id}/orders/{orderID}

Fill Test Return Envelope Order

POST/print-mail/v1/return_envelopes/{id}/orders/{orderID}/fills

Cancel Return Envelope Order

DELETE/print-mail/v1/return_envelopes/{id}/orders/{orderID}

ModelsExpand Collapse

ReturnEnvelopeOrder object { id, createdAt, live, 8 more }

id: string

A unique ID prefixed with return_envelope_order_

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: "return_envelope_order"

Always return_envelope_order.

quantityOrdered: number

The quantity of return envelopes ordered. Minimum 5000.

formatint32

minimum5000

returnEnvelope: string or ReturnEnvelope { id, available, createdAt, 6 more }

The ID of the return envelope that this order replenishes. Expanded into the full return envelope object on the individual order retrieval and cancellation endpoints when expand[]=returnEnvelope is supplied.

One of the following:

string

ReturnEnvelope object { id, available, createdAt, 6 more }

id: string

A unique ID prefixed with return_envelope_

available: number

The number of return envelopes available to use in your orders immediately. This increases when a return envelope order is filled and decreases as you send orders which include this return envelope.

formatint32

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: "return_envelope"

Always return_envelope.

to: object { id, addressLine1, addressStatus, 17 more }

The contact denormalized onto a return envelope when it is created. Unlike a full contact it is not a standalone resource, so it has no object, live, createdAt, or updatedAt fields.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" or "corrected" or "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.

addressErrors: optional string

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

addressLine2: optional string

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

city: optional string

The city of the contact’s address.

companyName: optional string

Company name of the contact.

description: optional string

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

email: optional string

Email of the contact.

firstName: optional string

First name of the contact.

forceVerifiedStatus: optional boolean

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

jobTitle: optional string

Job title of the contact.

lastName: optional string

Last name of the contact.

metadata: optional map[unknown]

See the section on Metadata.

phoneNumber: optional string

Phone number of the contact.

postalOrZip: optional string

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

provinceOrState: optional string

Province or state of the contact’s address.

secret: optional 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: optional 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

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

status: "placed" or "filled" or "cancelled"

The status of a return envelope order.

One of the following:

"placed"

"filled"

"cancelled"

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

quantityFilled: optional number

The quantity of return envelopes that were filled for this order. Only returned once the order’s status is filled.

formatint32