Skip to main content
GET

Get a Letter

Retrieve the details of a letter by its ID. You can only access letters that belong to your account.

Path parameters

string
required
The unique letter ID returned when the letter was created.

Response

string
The unique letter ID.
string
The letter status. One of: draft, processing, sent, delivered, failed.
string
The recipient name, if provided.
object
The structured address object.
string
The letter body text.
string
ISO 8601 timestamp of when the letter was created.
string
ISO 8601 timestamp of the last update.

Examples

Error codes