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 

http://<hostname>/api/organization/<zoid>/accounts/<accountid>

 Request Parameters

ParameterData TypeDescription
zoid* IntegerUnique identifier of your organization in Zoho 
accountid* IntegerUnique ID of the account of a user you wish to disable 

* - Mandatory parameters

  Request Body (JSON Object)

ParameterData TypeAllowed ValuesDescription
mode*String 

disableUser

 To disable a user account in the organization.

zuid*

LongUser's ZuidUnique ID of a user in Zoho

password*

StringAdmin PasswordThe password of your Admin account.

blockIncoming

BooleanTrue/False

By giving true, you block all incoming emails of a user.

removeMailforwardBooleanTrue/False

By giving true, you remove all forwarding added to that user account.

removeGroupMembershipBooleanTrue/False

By giving true, you remove the user from all groups.

* - Mandatory parameters

 Response Codes

Please refer Response Codes.

Sample Request


				{ 
"mode":"disableUser",
 "blockIncoming":"true",
 "removeMailforward":"true",
 "removeGroupMembership":"true",
 "password":"abcd123",
 "zuid":"11111111"
}