Batch update mailbox messages

curl --request POST \ --url https://app.sendmux.ai/api/v1/mailbox/messages:batch-update \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "ids": [ "<string>" ] } '

{ "ok": true, "meta": { "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx" }, "data": { "updated": [ "<string>" ], "not_found": [ "<string>" ], "failed": [ { "id": "<string>", "code": "<string>", "message": "<string>" } ], "states": { "old_state": "<string>", "new_state": "<string>" } } }

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

Required array length: 1 - 100 elements

seen

boolean

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.

Hide child attributes

keywords.{key}

boolean

Example:

{
  "$answered": true,
  "agent_triaged": true,
  "needs_reply": false
}

if_in_state

string

Optional message state token for stale-write protection.

Response

Batch update result

enum<boolean>

required

Available options:

true