Skip to main content
POST
Suspend a mailbox

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

Idempotency-Key
string

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

Maximum string length: 255
Example:

"mailbox-suspend-20260424-001"

Path Parameters

public_id
string
required

Mailbox public ID

Response

Suspended mailbox

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