DELETE Exchange Mailbox
From Hostway API Documentation
Revision as of 00:59, 2 July 2014 by Mike.robski (Talk | contribs)
DELETE /accounts/{accountNumber}/exchange/{domainName}/mailboxes/{useName}
Deletes an Exchange mailbox. The deletion process is asynchronous.
Contents |
Request
DELETE /accounts/{accountNumber}/exchange/{domainName}/mailboxes/{userName}
Request Parameters
- accountNumber - string
- the account number of the mailbox owner
- domaiName - string
- the domain name of the mailbox
- userName - string
- the username of the mailbox
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Request Body
None
Response
Status Code
- 202 - Accepted
- the deletion request has been accepted.
- 401 - Unauthorized
- the Authorization credentials are wrong or missing.
- 403 - Forbidden
- the user has been authorized. However, they are not allowed to access the resource. The only user(s) who has access to an Exchange mailbox must be a sales agent or the account owner, or the account technical admin.
- 404 - Not Found
- the mailbox does not exist.
- 409 - Conflict
- the deletion request was rejected due to conflict. Mailboxes with pending, close_pending, purge_pending status cannot be deleted.
Examples
Delete an existent open or closed mailbox
Request
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
Response
202 Accepted no-body
Delete an existent pending mailbox
Request
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
Response
409 Conflict { "conflict" : { "guid" : "<generated_value>", "message" : "Cannot delete pending mailboxes", "code" : 409, "details" : "" } }