PUT - Disable User Account

Purpose

The API is used to disable the mail account functionality for a user account. This can be done by the Admin for a user or by the user for themselves.

OAuth Scope

Use the scope

Using admin authentication:

ZohoMail.organization.accounts.ALL (or) ZohoMail.organization.accounts.UPDATE

Using user authentication:

ZohoMail.accounts.ALL (or) ZohoMail.accounts.UPDATE

to generate the Authtoken.

ALL - Grants full access to accounts.

UPDATE - Grants access to update account information.

Request URL

Method: PUT

Using admin authentication:

https://mail.zoho.com/api/organization/{zoid}/accounts/{accountId}

Using user authentication:

https://mail.zoho.com/api/accounts/{accountId}

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Get Organization Details API.
    • This parameter is mandatory only for admin authentication.
  • accountId* long
    • This parameter is used to identify the account of the user whose mail account is disabled.
    • This parameter can be retrieved from the Get User Account Details API.

Request Body (JSON Object)

  • zuid* long
    • This parameter denotes the unique identifier for each user in an organization. 
    • This value can be retrieved using the GET all org user details API.
    • This parameter is mandatory only for admin authentication.
  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as disableMailAccount.

 

Response Codes

Refer here for the response codes and their meaning.

Sample Request (Using Admin Authentication)

Copiedcurl "https://mail.zoho.com/api/organization/12345678/accounts/2560636000000008002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken ***" \
-d '{
   "zuid": 1111111,
   "mode": "disableMailAccount"
}'

Sample Request (Using User Authentication)

Copiedcurl "https://mail.zoho.com/api/accounts/2560636000000008002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
  "mode" : "disableMailAccount"
}'

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  }
}