Insert Record API for Adding Employees

Employees can be added to the Organisation using Insert Record API itself. Employee addition to the Organisation can be done in two ways in Zoho People. 

  1. Employee can be invited to join the Organisation through Invitation.
  2. If the Organisation have the domain verified in Zoho People, then users can be added directly to the organisation with email id as the user name and a initial password. 

Request URL:

https://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData=<inputData>

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Scope:

scope=ZOHOPEOPLE.forms.ALL
OR
scope = ZOHOPEOPLE.forms.CREATE 

For standalone Zoho People only, not applicable when Zoho People is part of Zoho One, People Plus or any other bundle.

ParameterDescription and ValueMandatory / Optional
input dataInput data for employee record in JSON format. Mandatory (For Employee addition, “EmployeeID”, “FirstName”, “LastName”, “EmailID” are mandatory)
isNonUsertrue or false. If true is sent, the user will be added as an employee profile in the system.Optional
isDirectAddtrue or false. If true is sent, the user will be added as an employee with active status  in the system.Optional
passwordany valid passwordMandatory if isDirectAdd is true
  1. If isDirectAdd parameter is not sent in the request, an employee record will be created with status as inactive and an invitation will be sent. 
  2. If isNonUser parameter is not sent in the request, by default the user will be added as an employee in the system. 

Example 1 (Without isNonUser and isDirectAdd Parameter)

Example 2 (Without isNonUser and with isDirectAdd)

​Example 3: (With isNonUser parameter)

 Threshold Limit:  300 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Example 1 (Without isNonUser and isDirectAdd Parameter)

Sample Request

Copiedhttps://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData={EmployeeID:'017',FirstName:'steves',LastName:'V',EmailID:'steves17@abccorpltd.tk'}

Header

CopiedAuthorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Sample Response

Copied{"response":{"result":{"pkId":"479732000000860055","message":"Successfully Added"},"message":"Data added successfully","uri":"/api/forms/json/employee/insertRecord","status":0}}

Example 2 (Without isNonUser and with isDirectAdd)

Copiedhttps://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData={EmployeeID:'018',FirstName:'Steve',LastName:'Waugh',EmailID:'steve18@abccorpltd.tk'}&isDirectAdd=true&password=testaccount@124

Header

CopiedAuthorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Sample Response

Copied{"response":{"result":{"pkId":"112674000000236001","message":"Successfully Added"},"message":"Data added successfully",
"uri":"/api/forms/json/employee/insertRecord","status":0}}

Example 3 (With isNonUser parameter)

Sample Request

Copiedhttps://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData={EmployeeID:'019',FirstName:'John',LastName:'Walker',EmailID:'John19@abccorpltd.tk'}&isNonUser=true

Header

CopiedAuthorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Sample Response

Copied{"response":{"result":{"pkId":"112674000000236023","message":"Successfully Added"},"message":"Data added successfully",
"uri":"/api/forms/json/employee/insertRecord","status":0}}