The delete_user method soft deletes a user's account. Once a user is deleted they will not be able to receive mail or access the system in any way.


   <credentials object>, 
   "user": <mailbox_name>

Request fields for delete_user

The following fields can be used in the delete_user method:

Field nameObligationDefinition/Value
userRequiredThe user's mailbox name.

Response fields for delete_user

The following fields may be returned in response to the delete_user 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_user


credentials object,
      "user": "[email protected]"
      "password": "abc123"
    "user": "[email protected]"


   "success": true