Get a batch with its live per-status rollup
Returns the letter_batch with a live rollup of its member letters: statusCounts maps each letter status to a count, and completed counts letters in a terminal state (delivered, undeliverable, canceled, or failed).
Returns the letter_batch with a live rollup of its member letters: statusCounts maps each letter status to a count, and completed counts letters in a terminal state (delivered, undeliverable, canceled, or failed). The batch is finished when completed equals total. List the individual letters with GET /v1/letters?batchId=...; responds 404 when the batch id is unknown. 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 batch's ID. |
Response
200 Success. Body: application/json, LetterBatch.
| Field | Type | Required | Description |
|---|---|---|---|
object | "letter_batch" | yes | |
id | string | yes | |
templateId | string or null | no | |
status | string | yes | |
total | integer | yes | |
completed | integer | no | Member letters in a terminal state (delivered, undeliverable, canceled, failed). |
statusCounts | map of integer | no | Live count of member letters keyed by their letter status. |
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). |