Deskhero Developer Hub
Back to deskhero.com
Mailboxes

Delete auth

Puts the mailbox into the re-authentication state rather than deleting anything: mail fetching is deactivated, the status becomes require-reauth and an email asking for the mailbox to be reconnected is sent to every Owner and Admin of the workspace. The OAuth identifier currently stored on the mailbox has to be sent in, a stale one is rejected.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/mailboxes/delete_auth
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
inputDTO_mailbox_delete_authBody
Request body example

Response

Status
200 (OK)
Type
DTO_acknowledgement
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_mailbox_delete_auth
NameTypeReadOnlyDescription
oauth2DTO_external_auth_oauth2Oauth2
idInt32Id
DTO_acknowledgement
NameTypeReadOnlyDescription
messageStringMessage
DTO_external_auth_oauth2
NameTypeReadOnlyDescription
identifierStringIdentifier
authorized_accountStringReadOnlyAuthorized account

Generated Aug 4, 2026 18:37