Skip to main content
PATCH
/
mailboxes
/
{public_id}
Update a mailbox
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.

Authorizations

Authorization
string
header
required

Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...

Headers

If-Match
string

Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.

Path Parameters

public_id
string
required

Mailbox public ID

Body

application/json
display_name
string | null
Required string length: 1 - 255
quota_bytes
integer
Required range: x >= 1
send_scope
object

Response

Updated mailbox

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