cherami.
API referenceSaved drafts

List drafts

GET /v1/inboxes/{inbox_id}/drafts

Read as Markdown ↗

GET /v1/inboxes/{inbox_id}/drafts

Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.

Lists the inbox's drafts, newest first, filtered by state. Drafts don't appear in mail listings, search or conversations until sent.

Parameters

ParameterLocationRequiredTypeMeaning
inbox_idpathYesstringCherami resource ID returned by the API.
limitqueryNointegerResults per page. minimum: 1 maximum: 100 default: 20
cursorqueryNostringnext_cursor from the previous page. Keep the URL, filters and order unchanged.
statequeryNo"draft" or "submitted" or "all"draft: unsent drafts. submitted: drafts with a send attempt. all: both, for checking whether an uncertain creation happened. Only limit, cursor and state are accepted, each at most once. default: draft

curl example

Supply CHERAMI_API_KEY privately.

curl --silent --show-error --include --request GET \
  "https://cherami.to/v1/inboxes/INBOX_ID/drafts" \
  --header "Authorization: Bearer $CHERAMI_API_KEY"

Responses

HTTP 200

Success.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

FieldRequiredTypeMeaning and constraints
draftsYesarray of DraftMetadata
next_cursorYesstring or null
{
  "drafts": [],
  "next_cursor": null
}

HTTP 400

invalid_limit: Use an integer from 1 to 100.

invalid_cursor: Send a cursor only to the listing, filters and order that returned it, or restart from the first page.

invalid_draft: Correct the draft field, source or listing parameter the message names.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 401

unauthorized: Send a valid API key as Authorization: Bearer <key>. If the key stopped working, get a new one through recovery.

  • X-Request-ID: Identifies this request; include it when reporting a problem.
  • WWW-Authenticate: "Bearer"

Content type: application/json.

Error

HTTP 404

not_found: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 503

draft_unavailable: The draft request failed. Repeat a draft send with the same draft ID: it never sends twice. Repeat a creation with its original idempotency key and payload; without a key, list drafts first. Read the draft before repeating an edit. Retry a read or a deletion.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

Schema: DraftMetadata

FieldRequiredTypeMeaning and constraints
idYesstringCherami resource ID.
inbox_idYesstringCherami resource ID.
stateYes"draft" or "submitted"
subjectYesstring
created_atYesstringUTC timestamp with milliseconds. format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
updated_atYesstringUTC timestamp with milliseconds. format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
sent_message_idYesstring or null

Schema: Error

FieldRequiredTypeMeaning and constraints
errorYesobject

error fields

FieldRequiredTypeMeaning and constraints
codeYesstringCode to handle. Handle a code you don't recognize by its HTTP status.
messageYesstringExplanation of this case; its wording can change.

Errors, limits and pagination · Download OpenAPI 3.1

On this page