Skip to main content
PATCH
Update mailbox message flags

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match
string

Path Parameters

message_id
string
required

Query Parameters

mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Body

application/json
flagged
boolean
keywords
object

Map of message keyword names to booleans. true sets the keyword; false clears it. Keyword names are normalised to lowercase. Lifecycle keywords such as $draft are read-only.

Example:
seen
boolean

Response

Updated message

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required