Mailboxes
Messages

Get an inbox reply draft

Read one reply draft with its status and stored content. Returns 404 when the draft is not in that conversation. subject, html and text are null, and to and cc are empty, once the stored draft no longer exists (after a send or cleanup).

get/mailboxes/{id}/inbox/threads/{thread_id}/drafts/{draft_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/inbox/threads/{thread_id}/drafts/{draft_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Reply draft.

object'inbox_reply_draft' required
idstring required
mailbox_idstring required
thread_idstring required

Deprecated and not stable: a legacy thread ID that changes when the mail server re-threads its IDs or a relayed send's placeholder key is replaced. It remains supported in thread paths; store conversation_id instead.

conversation_idstring required

Stable Shipmail conversation identifier (thd_...). Store this: it survives thread merges and mail-server re-threading, which thread_id does not.

based_on_message_idstring nullable required
expected_versioninteger required
reply_mode'reply' | 'reply_all' required
status'draft' | 'sending' | 'sent' | 'invalidated' | 'failed' required
subjectstring nullable required

Stored subject. Null once the stored draft no longer exists (after a send or cleanup).

htmlstring nullable required

Stored HTML after sanitisation. Null once the stored draft no longer exists.

textstring nullable required

Stored text part. Null once the stored draft no longer exists.

sent_message_idstring nullable required

ID of the sent message once the draft is sent.

created_atstring date-time required
updated_atstring date-time required
sent_atstring date-time nullable required

Changes

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