delete_domain

The delete_domain method deletes a domain. The domain must not have any users in it.

Syntax

{
    <credentials object>, 
    "domain": <domain_name>
}

Request fields for delete_domain

The following fields can be used in the delete_domain method:

Field nameObligationDefinition/Value
domainRequiredThe name of the domain that you want to delete.

Response fields for delete_domain

The following fields may be returned in response to the delete_domain method:

Field nameObligationDescription/Value
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
successAlways returnedIndicates whether the request was successful or not. Allowed values are true and false.

Examples for delete_domain

Request

{
    "credentials":{
			"user": "[email protected]",
      "password": "seekrit"
    }
    "domain": "example2.com",
}

Response

{
   "success": true
}