Return Envelopes

Create Return Envelope

Changed on

Creates a new return envelope. Note that if there is already a return envelope for the destination contact, this will fail with a return_envelope_already_exists_error.

post/print-mail/v1/return_envelopes

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/return_envelopes
  • Auth
    API key in header X-API-Key

Headers

idempotency-keystring

Request body

descriptionstring

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

metadataobject

See the section on Metadata.

Response

The newly created return envelope.

idstring required

A unique ID prefixed with return_envelope_

descriptionstring

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

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

Changes