Get Return Envelope

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

Gets the information for a return envelope by id. This should be a unique identifying string starting with return_envelope_.

Path ParametersExpand Collapse

id: string

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

Get Return Envelope

curl https://api.postgrid.com/print-mail/v1/return_envelopes/$ID \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

{
  "id": "return_envelope_7mhJUt25TnagyYzy1N81SJ",
  "object": "return_envelope",
  "live": false,
  "available": 0,
  "to": {
    "id": "contact_pxd7wnnD1xY6H6etKNvjb4",
    "companyName": "PostGrid",
    "addressLine1": "90 CANAL ST STE 600",
    "city": "BOSTON",
    "provinceOrState": "MA",
    "postalOrZip": "90210-1234",
    "countryCode": "US",
    "addressStatus": "verified"
  },
  "createdAt": "2021-12-16T03:06:17.419Z",
  "updatedAt": "2021-12-16T03:06:17.419Z"
}

Returns Examples

{
  "id": "return_envelope_7mhJUt25TnagyYzy1N81SJ",
  "object": "return_envelope",
  "live": false,
  "available": 0,
  "to": {
    "id": "contact_pxd7wnnD1xY6H6etKNvjb4",
    "companyName": "PostGrid",
    "addressLine1": "90 CANAL ST STE 600",
    "city": "BOSTON",
    "provinceOrState": "MA",
    "postalOrZip": "90210-1234",
    "countryCode": "US",
    "addressStatus": "verified"
  },
  "createdAt": "2021-12-16T03:06:17.419Z",
  "updatedAt": "2021-12-16T03:06:17.419Z"
}