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,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "email": "agent@acme.com",
    "display_name": "<string>",
    "quota_bytes": 123,
    "send_scope": {
      "provider_public_ids": [
        "<string>"
      ],
      "group_public_ids": [
        "<string>"
      ]
    },
    "status": "active",
    "created_at": "<string>"
  }
}

Mailboxes

Update a mailbox

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 can only be set to 1073741824 (1 GB), 5368709120 (5 GB), or 53687091200 (50 GB), and 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.

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,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "email": "agent@acme.com",
    "display_name": "<string>",
    "quota_bytes": 123,
    "send_scope": {
      "provider_public_ids": [
        "<string>"
      ],
      "group_public_ids": [
        "<string>"
      ]
    },
    "status": "active",
    "created_at": "<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.

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 - 254

quota_bytes

integer

Storage quota in bytes. Allowed values: 1073741824 (1 GB), 5368709120 (5 GB), 53687091200 (50 GB).

Required range: x >= 1

Example:

5368709120

send_scope

object

Hide child attributes

send_scope.type

enum<string>

required

Available options:

all,

providers,

group

send_scope.provider_public_ids

string[]

Required string length: 1 - 128

send_scope.group_public_ids

string[]

Required string length: 1 - 128

Response

Updated mailbox

ok

enum<boolean>

required

Available options:

true

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data

object

required

Hide child attributes

data.id

string

required

Public ID

Example:

"mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data.email

string

required

Mailbox email address (lowercase)

Example:

"agent@acme.com"

data.display_name

string | null

required

Optional display name shown in outbound From headers

data.quota_bytes

integer | null

required

Storage quota in bytes. Current writable tiers are 1 GB, 5 GB, and 50 GB.

data.send_scope

object

required

Hide child attributes

data.send_scope.type

enum<string>

required

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.

Available options:

all,

providers,

group

data.send_scope.provider_public_ids

string[]

Provider public IDs (only when type=providers)

data.send_scope.group_public_ids

string[]

Delivery group public IDs (only when type=group)

data.status

string

required

active | suspended | deleted

Example:

"active"

data.created_at

string

required

ISO 8601 creation timestamp

Delete a mailbox