Associate Candidate

Purpose

To associate a candidate with a job opening. 

Request URL

https://recruit.zoho.com/recruit/v2/Candidates/actions/associate

Request Method

PUT

Scope

scope= ZohoRecruit.modules.all
(or)
scope=ZohoRecruit.modules.candidate.UPDATE
(or)
scope=ZohoRecruit.modules.candidate.ALL

Possible module namesPossible operation types
candidate and jobopeningALL - Full access to the record
READ - Get records from the module

Possible Errors

Error CodeMessage

ALREADY_ASSOCIATED

 

The candidate is already associated with a job.

MANDATORY_NOT_FOUND

Mandatory input parameters are missing.

RECORD_LOCKED

No actions can be performed on a locked record. Unlock and try again.

INVALID_DATA

The given candidate ID is invalid.

BLOCKED_RECORD

The record is either restricted or the candidate has opted-out.

ID_ALREADY_DELETED

The candidate record has been deleted.

SUCCESS

The candidate has been successfully associated.

FAILURE

The candidate hasn't been associated. Review the Candidate and Job Opening IDs used. 

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates/actions/associate"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Input

Copied{
   "data": [
    {
      "jobids": ["100001000000025015","100001000000025001"],
      "ids": ["100001000000027011","100001000000027002"],
      "comments":"Record successfully associated"
     }
   ]
 }

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "jobid": "100001000000025001",
                "ids": "[100001000000027002, 100001000000027011]"
            },
            "message": "Record associated successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "jobid": "100001000000025015",
                "ids": "[100001000000027002, 100001000000027011]"
            },
            "message": "Record associated successfully",
            "status": "success"
        }
    ]
}