/v1/mailboxes/{id}Disconnect a mailbox
Disconnects one mailbox, which is the same act as ceasing to watch it: nothing more is ingested and the address stops being one the workspace can send as. Answers removed, plus a note when the provider's own subscription could not be cancelled — the honest third answer, since refusing would trap somebody in a connection they ended and a clean success would leave a live subscription pushing at a mailbox that is gone. An admin's route.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"note": "string",
"removed": true
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}