Sign in
Mailboxes

Update a mailbox

Changed on

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}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes/{public_id}
  • 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.admin.manage)

Path parameters

public_idstring required

Mailbox public ID

Headers

If-Matchstring

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

Request body

display_namestring nullable

Replace the display name; send null to clear it.

quota_bytesinteger

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

Example request

{
  "quota_bytes": 5368709120
}

Response

Updated mailbox

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "email": "agent@acme.com",
    "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "active"
  }
}

Changes