Mailboxes

Update inbox thread attention

Complete, reopen, or schedule follow-up for a thread using optimistic version concurrency.

patch/mailboxes/{id}/inbox/threads/{thread_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/inbox/threads/{thread_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.

Request body

OR

Response

Updated attention state.

object'inbox_thread_attention' required
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.

attention_state'needs_reply' | 'waiting_on_them' | 'done' | 'follow_up_due' | 'delivery_failed' | 'no_action' required
versioninteger required
attention_sincestring date-time nullable required
done_atstring date-time nullable required
follow_up_atstring date-time nullable required

Changes

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