Letters
Create a Letter
Create a letter as a draft or send it immediately.
POST
Create a Letter
Create a physical letter by providing recipient details, a validated address, and the letter content. By default, the letter is sent immediately. Setsend to false to create a draft you can review and send later.
Request
Name of the recipient. Maximum 30 characters.
The recipient’s postal address.
The letter body text. Line breaks (
\n) are preserved for formatting.Whether to send the letter immediately. Set to
false to create a draft. Drafts can be updated with PATCH /api/v1/letters/:id and sent with POST /api/v1/letters/:id/send.Response
The unique letter ID.
The letter status —
"processing" when sent immediately, "draft" when created as a draft.Your remaining balance in cents after this letter. Only present when
send is true.Examples
Error codes
| Status | Description |
|---|---|
400 | Invalid request body — missing or invalid fields |
401 | Missing, invalid, or revoked API key |
402 | Insufficient balance to send the letter (only when send is true) |
500 | Internal server error |
