Email

Mark messages as read or unread

Compatibility endpoint for retry-safe read-state updates. Returns the canonical durable per-item operation receipt plus the legacy count. Supply and reuse the Idempotency-Key header or compatibility idempotency_key field after timeouts.

patch/api/emails/{address}/messages/read

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/emails/{address}/messages/read
  • Auth: HTTP bearer

Path parameters

addressstring required

Mailbox email address (URL-encoded)

Headers

Idempotency-Keystring

Stable key for this exact logical batch

Request body

message_idsstring[] required

IDs of messages to mark

readboolean required

true to mark as read, false to mark as unread

idempotency_keystring

Response

Messages updated with durable receipt

operation_idstring required
idempotency_keystring required
idempotent_replayboolean required

True when this response reused the immutable completed receipt and performed no new mutation.

action'move' | 'mark_read' | 'star' | 'restore' | 'delete_permanently' | 'label' required
status'succeeded' | 'partial' required
created_atstring date-time required
completed_atstring date-time nullable required
countinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.