curl --request PATCH \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"ok": true,
"data": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Updates any combination of display_name, quota_bytes, and send_scope on a mailbox. The display_name and send_scope changes land in a single transaction; quota_bytes is applied afterwards because it also updates external state on our mail platform. Quota cannot be shrunk below the mailbox’s current usage.
For optimistic concurrency, send If-Match: <etag> using the ETag from a prior GET. A mismatched If-Match returns 409 conflict (the server’s ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
curl --request PATCH \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"ok": true,
"data": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}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.
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.
Mailbox public ID
1 - 255x >= 1Updated mailbox
true Hide child attributes
Public ID
"mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
Mailbox email address (lowercase)
"agent@acme.com"
Optional display name shown in outbound From headers
Storage quota in bytes
Hide child attributes
Outbound routing strategy. all lets the mailbox use any team-configured provider; providers restricts to the listed provider IDs; group routes via a delivery group.
all, providers, group Provider public IDs (only when type=providers)
Delivery group public IDs (only when type=group)
active | suspended | deleted
"active"
ISO 8601 creation timestamp
Was this page helpful?