UserManager
Subaccount Management
Delete Subaccount
This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.
- If one service account uses the same username and domain, the function returns the service account's information.
- If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.
Note:
- A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.
- This function returns only metadata if the specified username and domain do not match any service accounts or hypothetical Subaccounts.
get/UserManager/delete_user
Query parameters
domainstring domain required
Example:example.com
The Subaccount's associated domain. The domain must be one that the cPanel account owns.
usernamestring required
Example:example
The Subaccount's username.
- Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_)
Note:
This value does not include the domain name.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "delete_user",
"module": "UserManager",
"result": {
"data": {
"alternate_email": "user@example.com",
"avatar_url": "https://img.example.com/avatars/example.jpg",
"can_set_password": 1,
"dismissed": 1,
"domain": "example.com",
"full_username": "user@example.com",
"guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
"invite_expiration": 1466258282,
"issues": [
{
"area": "quota",
"limit": 1500,
"message": "Your account is over quota.",
"service": "email",
"type": "info",
"used": 2000
}
],
"parent_type": "hypothetical",
"phone_number": "+15551234567",
"real_name": "John Doe",
"services": {
"email": {
"enabled": 1,
"quota": 100
},
"ftp": {
"homedir": "/account",
"quota": 100
},
"webdisk": {
"homedir": "/bob",
"perms": "rw"
}
},
"special": 1,
"type": "service"
},
"status": 1
}
}