updateRecords

Purpose

You can use the updateRecords method to update or modify the records in Zoho Recruit.

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

Request URL

XML Format

To update single record into a module in a single API call:

https://recruit.zoho.com/recruit/private/xml/Module/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&id=Record ID&xmlData=XMLData

To update multiple records into a module in a single API call:

https://recruit.zoho.com/recruit/private/xml/Module/updateRecords?authtoken=AuthToken&scope=recruitapi&version=4&xmlData=XMLData

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
id*	String	Specify uniqueID of the record
xmlData*	XML	Specify fields and corresponding values
wfTrigger	Boolean	Set value as true to trigger the workflow rule while updating records in Recruit account. By default, this parameter is false.
newFormat	Integer (1 or 2)	newFormat=1: To exclude fields with "null" values while updating data from your Recruit account. newFormat=2: To include fields with "null" values while updating data from your Recruit account.
version	Integer	version = 2: This will fetch responses based on the latest API implementation. version = 4: To update multiple records in a single API method call.

Note: Parameters marked with * are mandatory.

Additional Notes

While updating 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 the highest role (Ex: Recruiter Admin) and profile (Ex: Administrator). Also, make sure all fields are enabled in the Field-level security settings. For role-based security settings, see Security Administration while generating API Ticket.

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

Update owner of the record

While updating 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.

Examples

To update records in Zoho Recruit, follow the steps below:

URL Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords

The parameters should be as given below:

authtoken: Auth Token

scope: Specify value as recruitapi.

xmlData: This is an XML string and the format should be same as how get records in XML format during your fetch API.

id: id of the record to be updated

version: version of the API (2 or 4)

XML data format:

https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords?newFormat=1&authtoken=AuthToken&scope=recruitapi&xmlData=XMLDATA

authtoken=xy4gr1554712345fg

scope=recruitapi

xmlData= as mentioned below

id = 1000000019001

version=2

<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>

Tasks with contact mapping:

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

<Tasks>
<row no="1">
<FL val="Subject">Meeting Hall</FL>
<FL val="Due Date">2009-04-22</FL>
<FL val="Status">Completed</FL>
<FL val="CONTACTID">2000000017027</FL>
</row>
</Tasks>

Events:

https://recruit.zoho.com/recruit/private/xml/Events/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017023
&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">Plaza</FL>
<FL val="Send Notification Email">false</FL>
</row>
</Events>

Contacts:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017024
&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">989898988</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
</row>
</Contacts>

Interviews:

https://recruit.zoho.com/recruit/private/xml/Interviews/updateRecords?authtoken=491e5e3374b0132324lqs2f1scb18cd0&
version=2&scope=recruitapi&id=508020000000366001&xmlData=

<Interviews>
<row no="1">
<FL val="Interview Owner">VT</FL><FL val="Interview Name"><![CDATA[Interview1]]></FL><FL val="Client Name">Client 2</FL><FL val="Interviewer">john@zohocorp.com</FL><FL val="Type">General Interview</FL><FL val="Candidate Name">Mark</FL><FL val="Posting Title">Lookup check</FL><FL val="Start DateTime">2015-01-23 15:30:00</FL>
</row>
</Interviews>

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/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=

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="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"> <![CDATA["A & A"]]> </FL>
</row>
</Contacts>

Multiple Record Updates

Purpose:

You can use updateRecords to update multiple records in a single updateRecords API method. Please note that version=4 is a mandatory parameter.

We have introduced a new code, that will represent the API result status for each record. The code is as given below:

2001 = Record Updated Successfully

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords?authtoken=AuthToken&scope=recruitapi&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

The functionality and response will be as given below:

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

<response uri="/recruit/private/xml/Candidates/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178701</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:

If you are using version=4, then you have to provide the Id within the xmlData.
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.
Kindly pass the version with value 2 or 4 as the old implementation will be deprecated soon.
You can update a maximum of 100 records in a single API call.

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	Zoho Forms for Enterprise
Contact Forms	E-commerce
Lead Generation Forms	Healthcare
Wordpress Forms	Customer onboarding
No Code Forms	Construction
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms
Form Designer
Card Forms
Assign Forms
Translate Forms
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder

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

You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Layout Rule Exceptions
Layout rules are effective when creating a record manually. However, when a field used in a layout rule is updated through other ways such as workflow update, and APIs, the field update takes precedence over both these rules. These instances are ...
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 ...
Points To Note While Updating A Field Used In A Validation Rule
Validation Rules are effective on creating a record manually. However, when fields used in a validation rule (whether primary or secondary) are updated through other ways such as workflow update, and APIs, the field update takes precedence over the ...