Mailbox API

Batch update mailbox messages

Changed on

Updates allowed message flags and keywords for up to 100 messages with state-safe conflict handling.

post/mailbox/messages:batch-update

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages:batch-update
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.settings.update)

Query parameters

mailbox_idstring

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.

Request body

flaggedboolean

Set or clear the flagged marker.

idsstring[] required

Message IDs to update, maximum 100.

if_in_statestring

Optional message state token for stale-write protection.

keywordsobject

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.

seenboolean

Set or clear the seen flag.

Example request

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

Response

Batch update result

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes