PUT - To Disable User
Purpose
The API can be used by the admin to disable a user account. Upon disabling, the user will not be able to sign in with their POP account.
Request URL
https://<hostname>/api/organization/<zoid>/accounts/<accountid>
Request Parameters
| Parameter | Data Type | Description |
| zoid* | Integer | Unique identifier of your organization in Zoho |
| accountid* | Integer | Unique ID of the account of a user you wish to disable |
* - Mandatory parameters
Request Body (JSON Object)
| Parameter | Data Type | Allowed Values | Description |
| mode* | String | disableUser | To disable a user account in the organization. |
| zuid* | Long | User's Zuid | Unique ID of a user in Zoho |
| password* | String | Admin Password | The password of your Admin account. |
| blockIncoming | Boolean | True/False | By giving true, you block all incoming emails of a user. |
| removeMailforward | Boolean | True/False | By giving true, you remove all forwarding added to that user account. |
| removeGroupMembership | Boolean | True/False | By giving true, you remove the user from all groups. |
* - Mandatory parameters
Response Codes
Please refer Response Codes.
Sample Request
Copied{
"mode":"disableUser",
"blockIncoming":"true",
"removeMailforward":"true",
"removeGroupMembership":"true",
"password":"abcd123",
"zuid":"11111111"
}