PUT - Change IMAP Status for a user
Purpose
The API is used to change the IMAP status of a user from enabled to disabled or vice-versa.
Request URL
Using Admin Authentication:
https://<hostname>/api/organization/<zoid>/accounts/<accountid>
Using User Authentication:
https://<hostname>/api/accounts/<accountid>
Request Parameters
Parameter | Data Type | Description |
zuid* | Integer | zuid - The unique Zoho User Identifier for the organization |
accountid* | Integer | Account Id of the user for whom IMAP status has to be changed |
imapAccessEnabled* | Boolean | The IMAP Access Enabled Value can be set to True/ False to enable or disable the incoming for the account. |
* - Mandatory parameters
Request Body (JSON Object)
Parameter | Data Type | Allowed Values | Description |
mode* | String | updateIMAPStatus | To change the IMAP status for the particular account. |
* - Mandatory parameters
Response Codes
Please refer Response Codes.
Sample Request (Using Admin Authentication)
Copied{
"zuid": "1111111",
"mode": "updateIMAPStatus",
"imapAccessEnabled": "true"
}
Copied{
"mode": "updateIMAPStatus",
"popAccessEnabled": "true"
}