changeStatus

changeStatus

Purpose

You can use this method to change the candidate status with respect to the job openings in Zoho Recruit.
Note: Use the POST method to pass these parameters instead of GET method.

Request URL

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
candidatestatus, jobopeningstatus, interviewstatus
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
jobId
String

Specify uniqueID of the Job Opening record for which the associated candidate status has to be changed.

This parameter is mandatory if you wish to change the status of a candidate associated with a job opening.

candidateIds*
String
Specify candidate ids, separated by a comma, for which the status has to be changed, with respect to the job opening.
version*
Integer
Use version=2: This will fetch responses based on the latest API implementation
candidateStatus*
String
Specify the status of the candidate with respect to the job opening.
comments
String
Specify the comments for the change in status.

Note: Parameters marked with * are mandatory.

Example

To change the status of the candidates with respect to the job openings.
URL Format:
candidateIds=54290000000022332,54290000000089027&
candidateStatus=Hired&comments="Placed in Java Development"&lock=true
Response Format:
<response uri="/recruit/private/xml/Candidates/changeStatus">
<result>
<message>Candidate(s) status changed successfully</message>
<recorddetail>
<FL val="jobId"> 292114000000087156</FL>
<FL val="candidateStatus">Hired</FL><FL val="comments"> Placed in Java Development</FL>
</recorddetail>
</result>
</response>

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

    • Custom Functions

      Zoho Recruit Custom functions help you to update data in related Recruit modules or third-party applications by executing simple program scripts. When a record matches the workflow criteria, workflow engine automatically triggers the custom ...