Remove a mailbox

DELETE /api/2.0/mailserver/mailboxes/remove/{id}

Request

Deletes a mailbox with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Path

idintegerformat: int32

Mailbox ID

Examples

DELETE /api/2.0/mailserver/mailboxes/remove/%7Bid%7D HTTP/1.1
Accept: application/json
Host: example.com
curl --request DELETE \
  --url https://example.com/api/2.0/mailserver/mailboxes/remove/%7Bid%7D \
  --header 'Accept: application/json'

Responses

200

Operation status

Completedboolean
Idstring
Statusstring
Errorstring
Percentsintegerformat: int32
Sourcestring
OperationTypeintegerformat: int32
Operationstring

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).