Skip to main content
POST
/
mailbox
/
messages:batch-update
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>"
  ]
}
'
{
  "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>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.

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.

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

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