API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Virtual 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

POST/print-mail/v1/virtual_mailboxes

List Virtual Mailboxes

GET/print-mail/v1/virtual_mailboxes

Retrieve Virtual Mailbox

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

Retrieve Physical Address

GET/print-mail/v1/virtual_mailboxes/{id}/address

ModelsExpand Collapse

VirtualMailboxCreateResponse object { id, capabilities, countryCode, 7 more }

The virtual mailbox object.

id: string

A unique ID prefixed with virtual_mailbox_

capabilities: object { envelopeScans, forwardMailTo }

All of the capabilities a virtual mailbox may have.

envelopeScans: boolean

Indicates if the virtual mailbox can produce scans of envelopes.

forwardMailTo: optional Contact { id, addressLine1, addressStatus, 20 more }

A contact to forward any returned mail to.

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.

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

skipVerification: optional boolean

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

countryCode: "US"

All of the supported countries for virtual mailboxes.

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

Always “virtual_mailbox”.

status: "active" or "pending_assignment"

The possible statuses of virtual mailboxes.

One of the following:

"active"

"pending_assignment"

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.

VirtualMailboxListResponse object { id, capabilities, countryCode, 7 more }

The virtual mailbox object.

id: string

A unique ID prefixed with virtual_mailbox_

capabilities: object { envelopeScans, forwardMailTo }

All of the capabilities a virtual mailbox may have.

envelopeScans: boolean

Indicates if the virtual mailbox can produce scans of envelopes.

forwardMailTo: optional Contact { id, addressLine1, addressStatus, 20 more }

A contact to forward any returned mail to.

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.

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

skipVerification: optional boolean

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

countryCode: "US"

All of the supported countries for virtual mailboxes.

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

Always “virtual_mailbox”.

status: "active" or "pending_assignment"

The possible statuses of virtual mailboxes.

One of the following:

"active"

"pending_assignment"

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.

VirtualMailboxRetrieveResponse object { id, capabilities, countryCode, 7 more }

The virtual mailbox object.

id: string

A unique ID prefixed with virtual_mailbox_

capabilities: object { envelopeScans, forwardMailTo }

All of the capabilities a virtual mailbox may have.

envelopeScans: boolean

Indicates if the virtual mailbox can produce scans of envelopes.

forwardMailTo: optional Contact { id, addressLine1, addressStatus, 20 more }

A contact to forward any returned mail to.

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.

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

skipVerification: optional boolean

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

countryCode: "US"

All of the supported countries for virtual mailboxes.

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

Always “virtual_mailbox”.

status: "active" or "pending_assignment"

The possible statuses of virtual mailboxes.

One of the following:

"active"

"pending_assignment"

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.

VirtualMailboxRetrieveAddressResponse object { addressLine1, countryCode, addressLine2, 3 more }

The address information for a mailbox.

addressLine1: string

The address line 1 of the mailbox.

countryCode: "US"

All of the supported countries for virtual mailboxes.

addressLine2: optional string

The address line 2 of the mailbox.

city: optional string

The city of the mailbox.

postalOrZip: optional string

The postal or ZIP code of the mailbox.

provinceOrState: optional string

The province or state of the mailbox.

Virtual 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

List Virtual Mailbox Items

GET/print-mail/v1/virtual_mailboxes/{id}/items

Create Test Virtual Mailbox Item

POST/print-mail/v1/virtual_mailboxes/{id}/items

Retrieve Virtual Mailbox Item

GET/print-mail/v1/virtual_mailboxes/{id}/items/{itemID}

ModelsExpand Collapse

ItemListResponse object { id, createdAt, live, 7 more }

The virtual mailbox item object.

id: string

A unique ID prefixed with virtual_mailbox_item_

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

Always “virtual_mailbox_item”.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

virtualMailbox: string

The ID of the virtual mailbox associated with this item.

description: optional string

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

fileURL: optional string

A URL of the envelope scan PDF.

matchedLetter: optional string

The ID of the letter this item was matched to.

metadata: optional map[unknown]

See the section on Metadata.

ItemCreateResponse object { id, createdAt, live, 7 more }

The virtual mailbox item object.

id: string

A unique ID prefixed with virtual_mailbox_item_

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

Always “virtual_mailbox_item”.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

virtualMailbox: string

The ID of the virtual mailbox associated with this item.

description: optional string

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

fileURL: optional string

A URL of the envelope scan PDF.

matchedLetter: optional string

The ID of the letter this item was matched to.

metadata: optional map[unknown]

See the section on Metadata.

ItemRetrieveResponse object { id, createdAt, live, 7 more }

The virtual mailbox item object.

id: string

A unique ID prefixed with virtual_mailbox_item_

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

Always “virtual_mailbox_item”.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

virtualMailbox: string

The ID of the virtual mailbox associated with this item.

description: optional string

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

fileURL: optional string

A URL of the envelope scan PDF.

matchedLetter: optional string

The ID of the letter this item was matched to.

metadata: optional map[unknown]

See the section on Metadata.