POST · Email
Suspend or unsuspend a mailbox
Suspend or unsuspend a mailbox
/api/v1/email/account/actions/suspend
This scope is inferred from the method and the endpoint's group — the OpenAPI document does
not carry one per operation. The wire is authoritative; whoami reports what your
token actually holds.
Description
POST suspends the mailbox (logins, delivery and sending stop; the mail stays); DELETE unsuspends it. The result reports the flag read back off the node. The main system account cannot be suspended here.
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
address
required
|
string |
Responses
A 200 response returns the shape shown in the rail.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.