Mailboxes
Pause Mailboxes
Admin+: pause the named mailboxes (`mailbox_ids`) or every mailbox of a sending domain (`domain`): no send path uses them until an admin resumes them. Mailboxes already paused are left as they are. 404 for an unknown mailbox or a domain without mailboxes.
API key access
Needs the
admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.POST
/api/v1/deliverability/fleet/pauseAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
mailbox_ids?array<string>
Items
1 <= items <= 500domain?string
reason?string
Shown with the pause ("Paused by an admin: ").
Length
length <= 200Response Body
curl -X POST "http://localhost:8000/api/v1/deliverability/fleet/pause" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{}'{
"changed": 0,
"mailbox_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Empty
Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}