PUT - Change POP Status for a User

Purpose

The API is used to change the POP status of a user from enabled to disabled or vice-versa. This can be done by the Admin for a user or by the user for himself.

Request URL 

Using Admin Authentication:

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

Using User Authentication:

https://<hostname>/api/accounts/<accountid>

Request Parameters

ParameterData TypeDescription
zuid* Integerzuid - The unique Zoho User Identifier for the organization 
accountid* Integer Account Id of the user whose POP status has to be changed using this API
popAccessEnabled* BooleanThe popAccessEnabled Value can be set to True/ False to enable or disable the POP status for the account. 

* - Mandatory parameters

Request Body (JSON Object)

ParameterData TypeAllowed ValuesDescription
mode* String 

updatePOPStatus

 To change the POP status for the particular account. 

* - Mandatory parameters

Response Codes

Please refer Response Codes.

Sample Request (Using Admin Authentication)

Copied{
   "zuid": "1111111",
   "mode": "updatePOPStatus",
   "imapAccessEnabled": "true"
}
Copied{
   "mode": "updatePOPStatus",
   "popAccessEnabled": "true"
}