Disconnect this workspace's mailbox
Release the mailbox, destroy the stored credential and revoke at Google.
/v1/channels/email/mailboxAdmin- Operation id
- delete_mailbox
- Access
- An editor or a viewer is refused.
/v1/channels/email/mailboxRelease the mailbox, destroy the stored credential and revoke at Google.
Reconnecting later is a full re-consent, because the credential is gone by design rather than kept in case somebody changes their mind. A stored refresh token for a mailbox nobody claims is exactly the thing this feature must never leave lying around.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/channels/email/mailbox"{ "connected": true, "email_address": "string", "scopes": [ "string" ], "sendable": true, "polling": true, "inbound_cursor_set": true, "connected_at": "string", "healthy_at": "string", "last_polled_at": "string", "sent_today": 0, "checks": [ { "check": "authorisation", "status": "not_started", "detail": "string", "remediation": "string", "last_checked_at": "2019-08-24T14:15:22Z" } ]}