1. Purpose
  2. Request URL
  3. Request Parameters
  4. Example 
     

Purpose

You can use this method to change the candidate status with respect to the job openings in Zoho Recruit.

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

Request URL

XML Format

https://recruit.zoho.com/recruit/private/xml/Candidates/changeStatus?authtoken=Auth Token&scope=recruitapi

JSON Format

https://recruit.zoho.com/recruit/private/json/Candidates/changeStatus?authtoken=Auth Token&scope=recruitapi

Request Parameters

 

ParameterData TypeDescription
authtoken*StringEncrypted alphanumeric string to authenticate your Zoho credentials.
scope*StringSpecify the value as recruitapi.
jobIdStringSpecify uniqueID of the Job Opening record for which the associated candidate status has to be changed.
candidateIds*StringSpecify candidate ids, separated by comma, for which the status has to be changed, with respect to the job opening.
version*IntegerUse version=2: This will fetch responses based on the latest API implementation
candidateStatus*StringSpecify the status of the candidate with respect to the job opening.
commentsStringSpecify the comments for the change in status.

  * - Mandatory parameter

Example

To change the status of the candidates with respect to the job openings.

URL Format:

https://recruit.zoho.com/recruit/private/xml/Candidates/changeStatus?authtoken=Auth Token&scope=recruitapi&jobId=54290000000089027&candidateIds= 54290000000022332,54290000000089027&candidateStatus=Hired&comments=Placed in Java Development

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>