Partners

Delete a mailbox

Deletes the mailbox and its mail. Requires partner:write.

delete/customers/{id}/domains/{domain}/mailboxes/{address}

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

addressstring required

Full mailbox address, URL-encoded, e.g. hello%40smiledental.example

Response

Deleted

successboolean

Example response

{
  "success": true,
  "data": {
    "deleted": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.