Sign in
Mailboxes

Suspend a mailbox

Changed on

Suspends a mailbox without deleting messages, credentials, or settings. Suspended mailboxes cannot receive mail, authenticate to mailbox protocols, or send from the mailbox address. The operation is idempotent and accepts Idempotency-Key for safe retries.

post/mailboxes/{public_id}/suspend

Request

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

Idempotency-Keystring

Client-chosen unique key to safely retry the request. Cached for 24h per (team, endpoint, key).

Example:mailbox-suspend-20260424-001

Response

Suspended mailbox

oktrue required

Example response

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

Changes