drafts

List drafts

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

get/v1/inboxes/{inbox_id}/drafts

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/drafts
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Query parameters

limitinteger

Results per page.

cursorstring

next_cursor from the previous page. Keep the URL, filters and order unchanged.

state'draft' | 'submitted' | '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.

Response

Success.

next_cursorstring nullable required

Cursor for the next page, or null at the end. Send it with the same URL, filters and order.

Changes

No recorded changes to this operation across all 1 revision of this API.