POST - Create a user record

 

Purpose

Use this API to create a user record in the organization.


Authorization

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

Request URL 

Method: POST

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

Scope: ZohoVoice.agents.CREATE

Parameters:

Param Name

Data Type

Description

data*

JSONObject

Represents the user data in JSON format.

 

Example request body:

{
 "name": "Name ABC",
 "emailid": "abc@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"
 ]
}

Sample Request

Copiedcurl 'https://voice.zoho.com/rest/json/zv/api/users' --data-raw 'data=ENCODE({"name":"Demo","emailid":"demo@zoho.com","lang":"en","timezone":"GMT","departmentName":"","zvtRole":"3","associatedNumbers":[],"associatedAgents":[]})' -X POST -H "Authorization: Zoho-oauthtoken *****" -H "Content-Type: application/json"

Sample Response - Success

Copied{
  "code": "200",
  "userId": "406100000118000",
  "status": "SUCCESS"
}

Sample Response - Error

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