Update records in Zoho Recruit

Table of Contents

Note:

  • Each time the zoho.recruit.updateRecord integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.recruit.updateRecord integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

The zoho.recruit.updateRecord is used to update a record in Zoho Recruit. This task is based on the Zoho Recruit API - Update Record.

Syntax

<variable> = zoho.recruit.updateRecord(<module_name>, <record_ID>, <data_map>, <workflow_trigger>, <connection>);

where:

ParameterData typeDescription
<variable>KEY-VALUE variable which will hold the response returned by Zoho Recruit.
<module_name>TEXT 

module in which the record will be updated.

Applicable modules:

  • Candidates
  • JobOpenings
  • Contacts
  • Clients
  • Interviews
  • Custom Module
<record_ID>NUMBER 

ID of the record which will be updated.

Learn how to fetch the ID of a record after creating, searching it or fetching it.

<data_map>KEY-VALUE 

keys and values to update the record with the new data.

Note: Field names (keys) should be specified as given in the Zoho Recruit API.
<workflow_trigger>BOOLEAN
  • If this param is supplied with true, all the workflows configured for the specified module will be triggered for the current record.
  • If this param is supplied with false, no workflow will be triggered.
<connection>TEXT

The link name of the Zoho Recruit connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory in order for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter until you manually delete the authtoken from accounts.
  • Add relevant scopes mentioned in Zoho Recruit API while creating the connection.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Update a record in Candidates module

The following script updates a record in the "Candidates" module in Zoho Recruit.

 candidatesMap = Map();
 candidatesMap.put("Email","john@zylker.com");
 
 response= zoho.recruit.updateRecord("Candidates", 3342000000267001, candidatesMap, false, "recruit_connection");

where:

candidatesMap
is a KEY-VALUE variable which will hold keys and values required to update the record.
"Email"
is a TEXT that represents the label name of field in Zoho Recruit which will get updated.
"john@zylker.com"
is a TEXT that represents the updated value of field in Zoho Recruit.
"Candidates"
is a TEXT that represents the module in which the record will be updated.
false
is a BOOLEAN that indicates no workflow will be triggered.
"recruit_connection"
is a TEXT that represents the module in which the record will be updated.

The success response returned is of the following format:

{  
   "Is Locked":"false",
   "Candidate ID":"ZR_23_CAND",
   "CANDIDATEID":"1687000000106001",
   "Is Unqualified":"false",
   "Updated On":"2015-08-05 18:41:34",
   "Created By":"dinesh.d",
   "Is Attachment Present":"true",
   "Source":"Resume",
   "MODIFIEDBY":"1687000000077003",
   "Created Time":"2015-08-05 18:41:34",
   "Modified By":"dinesh.d",
   "SMOWNERID":"1687000000077003",
   "Candidate Status":"New",
   "Last Activity Time":"2015-08-05 18:41:34",
   "SMCREATORID":"1687000000077003",
   "Email Opt Out":"false",
   "Is Hot Candidate":"false",
   "Last Name":"No name",
   "Experience in Years":"0",
   "Candidate Owner":"dinesh.d"
}

Related Links