PUT - Enable User

Purpose

The API is used by the admin to reactivate a user account, restoring full access to Zoho Mail and all associated Zoho services.

OAuth Scope

Use the scope

ZohoMail.organization.accounts.ALL (or) 

ZohoMail.organization.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}

Path Parameters

  • zoid*  long
    • This parameter is the unique Zoho Organization Identifier for the organization.
    • This value can be retrieved using the GET organization details API.
  • accountId*  long

Request Body (JSON Object)

  • zuid*  long
    • This parameter is the unique identifier for each user in an organization.
    • This value can be retrieved using the GET all org user details API.
  • mode*  string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as enableUser.
  • unblockIncoming*  boolean
    • This parameter specifies whether to unblock the incoming for the specific user or not.
    • Allowed values :
      • true
      • false

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/accounts/111111111000" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken ***************" \
-d '{
  "mode": "enableUser",
  "unblockIncoming": "true",
  "zuid": "11111111"
}'

Sample Response

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