Menu

Zoho Recruit API - addRecords


Purpose

You can use this method to add data into Zoho Recruit from third-party applications.

Note: This is a POST only API.

Request URL to addRecords:

XML:
https://recruit.zoho.com/ats/private/xml/Module/addRecords?authtoken=Auth Token&scope=recruitapi

JSON: https://recruit.zoho.com/ats/private/json/Module/addRecords?authtoken=Auth Token&scope=recruitapi

Note: Replace Module with any one of this - JobOpenings, Candidates, Clients, ClientContacts.

Request Parameters:


Parameter Type Description
authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials. 
scope* String Specify the value as recruitapi
xmlData* XML This is an XML string and the format should be same as of getRecords in XML format of fetched records.
duplicateCheck Integer Set value as "1" to check the duplicate records and throw an error response or "2" to check the duplicate records, if exists, update the same.
emailAlert Boolean Set value as true to trigger the email alert while inserting the record into Recruit account. By default, this parameter is false.

* - Mandatory parameter

Duplicate Check Fields:

Module Name Duplicate Check Field
JobOpenings Posting title
Candidates Email ID
Clients Client
ClientContacts Email

Examples:

Insert records into Zoho Recruit from third-party applications

URL Format:
https://recruit.zoho.com/ats/private/xml/JobOpenings/addRecords?authtoken=Auth Token&scope=recruitapi&xmlData=XMLDATA 

XMLDATA JobOpening example:

<JobOpenings>
<row no="1">
<FL val="Posting title">Java Developer</FL>
<FL val="Client">ZOHO</FL>
<FL val="Assigned recruiter">0001</FL>
<FL val="Client manager">0001</FL>
<FL val="Job opening status">In-progress</FL>
<FL val="Number of positions">5</FL>
<FL val="Country">INDIA</FL>
<FL val="Roles and responsibilities">Develop web service with proper data model</FL>
<FL val="Attach doc">TVlTUUwgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMKRklMRSAxOTIuMTY4LjE1LjQ0IDE5Mi4xNjguMTUuOTUgMTkyLjE2OC4xNS43MwpCQUNLVVAgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMK</FL>
<FL val="Attach doc_filename">components.txt</FL>
</row>
</JobOpenings>

XMLDATA Candidates example:

<Candidates>
<row no="1">
<FL val="First name">Satvik</FL>
<FL val="Last name">Kothandaraman</FL>
<FL val="Contact address">my home</FL>
<FL val="Email ID">satvik@advent.com</FL>
<FL val="Contact number">44987654</FL>
<FL val="Total work exp (year)">5</FL>
<FL val="Total work exp (month)">5</FL>
<FL val="Current job title">SE</FL>
<FL val="Skill set">Java</FL>
<FL val="Resume status">New</FL>
<FL val="Attach resume"> TVlTUUwgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMKRklMRSAxOTIuMTY4LjE1LjQ0IDE5Mi4xNjguMTUuOTUgMTkyLjE2OC4xNS43MwpCQUNLVVAgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMK</FL>
<FL val="Attach resume_filename">components.txt</FL>
</row>
</Candidates>

The file attachment should be base64encoded and send to us. Along with the name of the file in a separate xml node with fieldlabel_filename as below example:
<FL val="Attach resume"> TVlTUUwgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMKRklMRSAxOTIuMTY4LjE1LjQ0IDE5Mi4xNjguMTUuOTUgMTkyLjE2OC4xNS43MwpCQUNLVVAgMTkyLjE2OC4xNS40NCAxOTIuMTY4LjE1Ljk1IDE5Mi4xNjguMTUuNzMK</FL>
<FL val="Attach resume_filename">components.txt</FL>

Response Format:
<response uri="/ats/private/xml/JobOpenings/addRecords">
<result>
<message>Record(s) added successfully</message>
<recorddetail>
<FL val="Id">54290000000089027</FL>
</recorddetail>
</result>
</response>