addRecords

Purpose

You can use the addRecords method to insert records into the required Zoho Recruit module.

Note: Use the POST method to pass these parameters instead of the GET method.

Request URL

XML Format:

https://recruit.zoho.com/recruit/private/xml/Module/addRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=Your_XML_Data

Note: Module refers to Candidates, JobOpenings, Clients, Interviews, Contacts, CustomModule1, CustomModule2, CustomModule3, CustomModule4, and CustomModule5.

For OAuth Authentication

Header Name
Value

Authorization
Zoho-oauthtoken {access_token}

Scopes

Scope=ZohoRecruit.modules.all

(or)

Scope=ZohoRecruit.modules.{scope_name}.{operation_type}

Possible Scope Names (Case Sensitive)

Operation Types

candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules) ALL - Full access to the record
READ - Get records from the module

For Authtoken Authentication

Parameter
Data Type
Description

authtoken*
String
Encrypted alphanumeric string to authenticate your Zoho credentials.

scope*
String
Specify the value as recruitapi

Request Parameters

Parameter	Data Type	Description
xmlData*	XML	This is an XML string and the format should be same as of getRecords in XML format of fetched records.
wfTrigger	Boolean	Set value as true to trigger the workflow rule while inserting record into Recruit account. By default, this parameter is false.
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.
isApproval	Boolean	By default, records are inserted directly.To keep the records in approval mode, set valueas true.You can use this parameter for Candidates, Contacts
newFormat	Integer	newFormat=1: To exclude fields with "null" values while inserting data from your Recruit account. newFormat=2: To include fields with "null" values while inserting data from your Recruit account.
version*	Integer	version = 1: (Default Value) This will fetch responses based on the earlier API implementation i.e prior to the enhancements made. version = 2: This will fetch responses based on the latest API implementation version = 4: To add multiple records in a single API method call and will trigger duplicate check functionality for multiple records.

Note: Parameters marker with * are mandatory.

Duplicate Check Fields

Module Name	Duplicate Check Field
Candidates	Email
Contacts	Email
Clients	Client Name
Job Openings	Posting Title
Interviews	Interview Name

Additional Notes

While inserting data in your Zoho Recruit account, role-based security (Roles, Profiles, Field-level security and Data sharing rules) is applied.

Hence, use the user ID with highestrole(Ex: Recruiter Admin) and profile (Ex: Administrator). Also, make sure all fields are enabled in the Field-level security settings.

While inserting data, make sure the date and time are in the "MM/dd/yyyy" and "yyyy-MM-dd | HH:mm:ss" formats respectively.

Examples

Insert records in Zoho Recruit from third-party applications

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&version=4&xmlData=

XMLDATA sample:

<Candidates>
<row no="1">
<FL val="Source">Web Download</FL>
<FL val="Current employer">Your Company</FL>
<FL val="First Name">Hannah</FL>
<FL val="Last Name">Smith</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Phone">1234567890</FL>
<FL val="Home Phone">0987654321</FL>
<FL val="Other Phone">1212211212</FL>
<FL val="Fax">02927272626</FL>
<FL val="Mobile">292827622</FL>
</row>
</Candidates >

Sample Candidate XMLDATA:

<Candidates>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Candidate Owner">Scott@zohotest.com</FL>
<FL val="Source">John</FL>

</FL><FL val="First Name">John</FL>

<FL val="Last Name">Gossling</FL>

<FL val="Email">john@zohocorp.com</FL>

<FL val="Candidate Status">Qualified</FL>

<FL val="Salutation">Mr.</FL>
<FL val="Street">Street One</FL>
<FL val="City">Chennai</FL>
<FL val="State">Tamil Nadu</FL>
<FL val="Zip Code">6000001</FL>
<FL val="Country">India</FL>
</row>
</Candidates>

Sample Task XMLDATA with Contact and Client lookup:

<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="CONTACTID">2000000018443</FL>
<FL val="SEID">2000022218013</FL>
<FL val="SEMODULE">Clients</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>

Sample Task XMLDATA with Contact and Client lookup:

<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="CONTACTID">2000000018443</FL>
<FL val="SEID">2000022218013</FL>
<FL val="SEMODULE">Accounts</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>

Insert notes and relate to the primary module

XML Format:

https://recruit.zoho.com/recruit/private/xml/Notes/addRecords?authtoken=AuthToken&scope=recruitapi&version=2

XMLDATA sample:

<Notes>
<row no="1">
<FL val="entityId">6000000119069</FL><FL val="Note Type">Meeting</FL><FL val="Type Id">6000000021005</FL><FL val="Note Content"><![CDATA[hello]]></FL><FL val="Parent Module">Candidates</FL>
</row>
</Notes>

Here the entityID is the unique ID of the primary record (Candidate, Client, Contact etc.)

Type Id is the Note Type Id which you can get from the getNoteTypes API.

Assign an owner to the record

While inserting a record through API, make sure you are specifying the email address or userID of the record owner. If you use the record owner's name, the record will be assigned to the default login credential used in the Auth Token. If you want to use the userID to specify the record owner, then add <FL val="SMOWNERID">userID</FL> tag to your xmlData.

Note: In the following examples, replace the values for 'authtoken' and 'scope' with those generated by you.

Tasks:

https://recruit.zoho.com/recruit/private/xml/Tasks/addRecords?authtoken=AuthToken&scope=recruitapi
&version=2&
xmlData=

<Tasks>
<row no="1">
<FL val="Subject">Call</FL>
<FL val="Due Date">2009-04-20</FL>
<FL val="Status">Deferred</FL>
<FL val="CONTACTID">2000000017017</FL>
</row>
</Tasks>

Events:

https://recruit.zoho.com/recruit/private/xml/Events/addRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&xmlData=

<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-08-04 01:00:00</FL>
<FL val="End DateTime">2009-08-05 01:00:00</FL>
<FL val="Venue">United States</FL>
<FL val="Send Notification Email">True</FL>
</row>
</Events>

Events with Contacts and Client Mapping:

https://recruit.zoho.com/recruit/private/xml/Events/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=

<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-09-24 01:00:00</FL>
<FL val="End DateTime">2009-09-25 01:00:00</FL>
<FL val="Venue">Chennai</FL>
<FL val="CONTACTID">2000000055003</FL>
<FL val="SEID">2000000055007</FL>
<FL val="SEMODULE">Clients</FL>
</row>
</Events>

Clients:

https://recruit.zoho.com/recruit/private/xml/Clients/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=

<FL val="Client Manager">john@zohocorp.com</FL>

<FL val="Website">www.zillum.com</FL>

<FL val="Industry">Real estate</FL>

</row>
</Clients>

Contacts:

https://recruit.zoho.com/recruit/private/xml/Contacts/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=

<Contacts>
<row no="1">
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">test@test.com</FL>
<FL val="Department">CG</FL>
<FL val="Phone">999999999</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
</row>
</Contacts>

Insert Calls with Contacts and Clients Lookup:

<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Product Support</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="CONTACTID">2000000018001</FL>
<FL val="SEID">2000000018003</FL>
<FL val="SEMODULE">Clients</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Required Product Demo</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>

Insert Calls with Candidates Lookup:

<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Demo</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="SEID">2000000017201</FL>
<FL val="SEMODULE">Candidates</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Demo Call</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>

Usage of 'CDATA'

Purpose:

To consider Special Characters as plain text and NOT XML Data

URL Format:

https://recruit.zoho.com/recruit/private/xml/Contacts/addRecords?version=2&authtoken=AuthToken&scope=recruitapi

Sample XML Data

as POST:

<Contacts>
<row no="1">
<FL val="First Name">Amy</FL>
<FL val="Last Name">Dawson</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Job Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"> <![CDATA["A & A"]]> </FL>
</row>
</Contacts>

Insert Multiple Records

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/addRecords?version=2&authtoken=AuthToken&scope=recruitapi

XMLDATA sample:

<Candidates>
    <row no="1"><FL val="Last Name">testing</FL><FL val="Email">test1@test.com</FL></row>
    <row no="2"><FL val="Last Name">testing</FL><FL val="Email">test2@test.com</FL></row>
    <row no="3"><FL val="Last Name">testing</FL><FL val="Email">test3@test.com</FL></row>
    <row no="4"><FL val="Last Name">testing</FL><FL val="Email">test4@test.com</FL></row>
    <row no="5"><FL val="Last Name">testing</FL><FL val="Email">test5@test.com</FL></row>
    <row no="6"><FL val="Last Name">testing</FL><FL val="Email">test6@test.com</FL></row>
    <row no="7"><FL val="Last Name">testing</FL><FL val="Email">test7@test.com</FL></row>
    <row no="8"><FL val="Last Name">testing</FL><FL val="Email">test8@test.com</FL></row>
    <row no="9"><FL val="Last Name">testing</FL><FL val="Email">test9@test.com</FL></row>
    <row no="10"><FL val="Last Name">testing</FL><FL val="Email">test10@test.com</FL></row>
:
:
:

    <row no="100"><FL val="Last Name">testing</FL><FL val="Email">test100@test.com</FL></row>
</Candidates >

Notes:

When inserting multiple records with the addRecords method:
We support duplicate check for multiple records in version 2
Workflow Rules will not be triggered for records that meet the criteria
Only the first 100 records will be considered when inserting multiple records.

Duplicate Check for Multiple Records

Purpose:

You can use addRecords to trigger duplicate check functionality for multiple records. Please note that version=4 is a mandatory parameter. We've introduced three new codes that will represent the API result status for each record. The codes are as given below:

2000 = Record Added Successfully
2001 = Record Updated Successfully
2002 = Record Already Exists

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&version=4&xmlData=

Sample XML Data:

<Candidates>
<row no="1">
<FL val="Current Employer">Company1</FL>
<FL val="Last Name">Last Name1</FL>
<FL val="Email">automation@recruit.com1</FL>
</row>
<row no="2">
<FL val="Current Employer">Company2</FL>
<FL val="Last Name">Last Name2</FL>
<FL val="Email">automation@recruit.com2</FL>
</row>
</Candidates>

Sample Response

If duplicateCheck=1 , version=4, some records exist with the email address and some records don't exist, the functionality and response will be as given below:

If duplicateCheck=1 , version=4 , no records exist with the email address, the functionality and response will be as given below:

If duplicateCheck=1 , version=4 , records exist with the email address, the functionality and response will be as given below:

If duplicateCheck=2 , version=4 , no records exist with the email address, the functionality and response will be as given below:

If duplicateCheck=2 , version=4 , records exist with the email address, the functionality and response will be as given below:

If duplicateCheck=2 ,version=4 , some records exist with the email address and some records don't, the functionality and response will be as given below:

If version=4, some records contain error and some don't, the functionality and response will be as given below:

<response uri="/recruit/private/xml/Candidates/addRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000120006</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no="2">
<error>
<code>4832</code>
<details>You have given a wrong value for the field : Annual Revenue</details>
</error>
</row>
</result>
</response>

Note:

Email Address is the duplicate check field for Candidates module. For other modules, the duplicate check field varies.
Developers can now easily identify the record id, since the record detail in the response, is given the same way the user requests in the xml data.
You have to pass version=2 in the parameter URL for duplicate check in multiple records.

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

Zoho DataPrep Personalized Demo

If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
Offline Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Order Forms for Small Business
No Code Forms	Construction
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms	Legal
Form Designer	HR
Card Forms	Food
Assign Forms	Photography
Translate Forms	Real Estate
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder HIPAA Forms Encrypted Forms

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
API Methods
Method Name Purpose getRecords To retrieve all users data specified in the API request getRecordById To retrieve individual records by record ID addRecords To insert records into the required Zoho Recruit module updateRecords To update or modify the ...
Record Origin
The Origin value of a record indicates how it entered your system. Origin is the precursor to a record's source, and is used to group various source values into broader categories. For example, under the origin value of “Sourced”, you’ll see the ...

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

Wherever you are is as good as

your workplace

Workplace on mobile

Resources

Videos

Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.

Watch Now

eBooks

Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.

Download eBooks

Webinars

CRM Tips

Make the most of Zoho CRM with these useful tips.

Learn More

Header Name	Value
Authorization	Zoho-oauthtoken {access_token}

Possible Scope Names (Case Sensitive)	Operation Types
candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules)	ALL - Full access to the record READ - Get records from the module

Zoho Recruit | addRecords Method

addRecords

Purpose

Request URL

For OAuth Authentication

Header Name Value Authorization Zoho-oauthtoken {access_token}

Scopes

For Authtoken Authentication

Parameter Data Type Description authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials. scope* String Specify the value as recruitapi

Request Parameters

Duplicate Check Fields

Additional Notes

Examples

Insert notes and relate to the primary module

Assign an owner to the record

Usage of 'CDATA'

Insert Multiple Records

Duplicate Check for Multiple Records

Access your files securely from anywhere

Zoho CRM Training Programs

Zoho DataPrep Personalized Demo

Start tracking your website metrics today

Ready to improve your website's performance?

Track and measure every business goal

Understand the customer journey on your website

Visualize your visitor's behavior with color codes

Measure customer engagement with your web forms

Record real visitor interactions on your website

Test and optimize webpages for better conversions

Give each customer a unique website experience

Grow your business through customer feedback

Send timely updates that customers love

Advertise your business to website visitors

Access more advanced settings in PageSense

Try easy-to-use extensions

Discover your favorite integrations with PageSense

Zoho Sheet Resources

Zoho Forms Resources

Zoho Sign Resources

Zoho TeamInbox Resources

Zoho DataPrep Resources

Related Articles

API Methods

Record Origin

Resources

Videos

eBooks

Webinars

CRM Tips

Zoho Show Resources

Header Name
Value

Authorization
Zoho-oauthtoken {access_token}

Parameter
Data Type
Description

authtoken*
String
Encrypted alphanumeric string to authenticate your Zoho credentials.

scope*
String
Specify the value as recruitapi