Skip to content

Mark Inbox Email Read

POST
/inbox/emails/{email_id}/mark-read

Mark an email thread read. Contacts nobody.

Best-effort syncs the read state up to the mail provider as well, so the customer’s own mailbox agrees. Idempotent.

Gated on VISIBILITY of the owning mailbox: a personal mailbox is owner-only, so marking someone else’s thread read is a 403 rather than a quiet mutation of their inbox.

Authorizations

Parameters

Path Parameters

email_id
required

Email thread id.

string

Email thread id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string