Get one letter template
Get one letter template (with its full HTML body)
Returns a single letter_template, including the full html body that list items omit. Responds 404 when the id does not exist or belongs to another account. Requires the letters:read scope.
Scope: letters:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | The letter template's ID. |
Response
200 Success. Body: application/json, LetterTemplate.
| Field | Type | Required | Description |
|---|---|---|---|
object | "letter_template" | yes | |
id | string | yes | |
name | string | yes | |
html | string | no | The branded letter HTML with {{placeholders}} and a blank recipient address window. Omitted from list items. |
variables | array of LetterTemplateVariable | no | Declared template variables, stored and returned as [{name, type?, example?, label?}]. |
status | LetterTemplateStatus | yes | |
createdAt | string (date-time) or null | no | |
updatedAt | string (date-time) or null | no |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Create a reusable letter template
Stores a reusable letter design: html carries the body and branding, with {{placeholder}} variables filled per letter at send time.
Update a letter template
Applies a partial update: provide at least one of name, html, variables, or status — an empty request is a 400, name/html cannot be set to empty strings, and html over 512 KiB is a 413.