PUT - Update a user 

 

Purpose

Use this API to update a user details.
 

Authorization

HeaderKeyDescription
Authorization*Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*Set to application/json.

Request URL

Method: PUT

https://voice.zoho.com/rest/json/zv/api/users

Scope: ZohoVoice.agents.UPDATE

Parameters:

Param Name

Data Type

Description

data*

JSONObject

Represents the user data in JSON format.

 

Example request body:

{
 "name": "Name ABC",
 "emailid": "demo@zoho.com",
 "lang": "en",
 "timezone": "GMT",
 "departmentName": "CRM Solutions",
 "zvtRole": "4",
 "isModerator": false,
 "associatedNumbers": [
   {
     "numberMapId": "4061000000335017",
     "allowNumberEdit": false
   },
   {
     "numberMapId": "4061000000336003",
     "allowNumberEdit": false
   }
 ],
 "associatedAgents": [
   "4061000000237005",
   "4061000001129005"
 ],
 "userid": 4061000001129005
}

 

Sample Request

Copiedcurl 'https://voice.zoho.com/rest/json/zv/api/users' -X 'PUT' --data-raw 'data=ENCODE({"name":"Divya SA()","emailid":"divya.e@zohocorp.com","lang":"en","timezone":"Asia/Ujung_Pandang","departmentName":"AlarmsOne123","zvtRole":"0","extension":"101","isModerator":false,"associatedNumbers":[],"associatedAgents":[],"userid":"2069000000002003"})'

Sample Response - Success

Copied{
  "code": "200",
  "userid": "2069000000002003",
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "ZVTL001",
  "message": "Licensed users limit exceeded. Please purchase more user licenses.",
  "status": "ERROR"
}