Skip to main content
POST
Batch update mailbox messages

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.

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
ids
string[]
required

Message IDs to update, maximum 100.

Required array length: 1 - 100 elements
flagged
boolean

Set or clear the flagged marker.

if_in_state
string

Optional message state token for stale-write protection.

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

Set or clear the seen flag.

Response

Batch update result

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