API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Contacts

Manage contacts that you can mail to. Test mode addresses will always have a verified status. In live mode, they may be verified, corrected, or failed. Addresses that fail to be corrected are likely undeliverable, but you can still send to them if you want to.

For test mode contacts, you have the ability to assert the addressStatus of the contact by passing specific values to the description field. To receive an addressStatus of failed, the description of the contact should be a string with the exact value test failed. For an addressStatus value of corrected, the description of the contact should be a string with the exact value test corrected.

Our address correction engine will often be able to fix missing postal/ZIP codes, city names, and also append ZIP+4. It is SERP (Canada Post) and CASS (USPS) certified, so you can rest assured that if an address is verified, we can deliver to it.

Create Contact

POST/print-mail/v1/contacts

List Contacts

GET/print-mail/v1/contacts

Get Contact

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

Delete Contact

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

ModelsExpand Collapse

Contact object { id, addressLine1, addressStatus, 21 more }

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.

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.

ContactCreate = ContactCreateWithFirstName { addressLine1, countryCode, firstName, 14 more } or ContactCreateWithCompanyName { addressLine1, companyName, countryCode, 14 more }

One of the following:

ContactCreateWithFirstName object { addressLine1, countryCode, firstName, 14 more }

addressLine1: string

The first line of the contact’s address.

countryCode: string

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

firstName: string

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.

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.

ContactCreateWithCompanyName object { addressLine1, companyName, countryCode, 14 more }

addressLine1: string

The first line of the contact’s address.

companyName: string

countryCode: string

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

addressLine2: optional string

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

city: optional string

The city of the contact’s address.

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.

ContactCreateWithCompanyName object { addressLine1, companyName, countryCode, 14 more }

addressLine1: string

The first line of the contact’s address.

companyName: string

countryCode: string

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

addressLine2: optional string

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

city: optional string

The city of the contact’s address.

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.

ContactCreateWithFirstName object { addressLine1, countryCode, firstName, 14 more }

addressLine1: string

The first line of the contact’s address.

countryCode: string

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

firstName: string

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.

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.

ContactDeleteResponse object { id, deleted, object }

id: string

A unique ID prefixed with contact_

deleted: true

object: "contact"

Always contact.