Get letter
Fetch details of a specific letter.
Response
Generic response for a resource request
A letter.
Represents the current status of a letter in the mailing process:
queued: Awaiting processingready: Processed and ready for printinginProduction: Being printed and prepared for mailingmailed: Handed off to postal service for deliveryissue: Problem that needs addressingcanceled: Letter will not be mailed
queued, ready, inProduction, mailed, issue, canceled "queued"
An object containing the sender's information for the letter. It must include:
Either an individual object, an organization string, or both.
- If
individualis provided, it can contain either afullNamestring or name components (at minimumfirstNameandlastName). - If only name components are provided, they will be used in the order specified in our API for addressing.
- If both
fullNameand name components are provided,fullNamewill be used for addressing.
An address object with the sender's complete address details.
This information is used to populate the return address on the letter. Ensure all provided details are accurate to facilitate any potential return mail handling.
Specifies the Send Date in ISO 8601 format (YYYY-MM-DD). Time portion, if provided, is ignored.
If omitted:
- SLA begins after the daily cutoff and we auto-assign a date based on our SLA:
- Before cutoff: Earliest production date (e.g., same day if sent 9 am Tuesday).
- After cutoff: Next production date (e.g., next day if sent 11 am Tuesday).
- Non-production day: Next production date.
If specified:
- Must be between current date and 180 days in future.
- If specified date is a production day, value remains as-is.
- If not a production day, next production day is assigned.
Daily cutoff: 10 am ET on production days (Monday - Friday, exluding national holidays)
Note: All letters are cancelable on or before the Send Date's daily cutoff.
Example: 2023-08-15
Customization options for letter production and delivery, including:
- Printing preferences (e.g., color, simplex/duplex)
- Mailing preferences (e.g., mail class, extra services)
- Data processing preferences (e.g., CASS, NCOA)
- Other preferences
Defaults apply if not specified. See Option documentation for details.
Note: Some options may affect pricing or production time.