Retrieve a mailing

GET
Retrieves the details of an existing mailing.

Path parameters

mailingIdstringRequired
The unique identifier for an existing mailing.

Response

This endpoint returns an object.
createdAtdatetime

The creation date and time of the mailing in ISO 8601 format.

fromobject
The mailing address of the sender.
idstring
The unique identifier for this mailing.
mailedFromIdstring

The documentId of the mailed document.

statusenum
Allowed values: CREATEDPROCESSING_FOR_DELIVERYIN_TRANSITDELIVEREDRETURNED_TO_SENDER
The status of the mailing.
toobject
The mailing address of the recipient.
urlstring
The URL to the mailed document.
userIdstringOptional
The unique identifier for a single end-user of your application.

Errors