Change Candidate Rating
Purpose
To update the rating of a candidate with respect to a job opening.
Request URL
https://recruit.zoho.com/recruit/v2/Candidates/actions/rating
module_api_name - The API name of the module
record_id - The unique Id of the record
Request Method
PUT
Scope
scope=ZohoRecruit.modules.ALL
(or)
scope=ZohoRecruit.modules.candidate.UPDATE
(or)
scope=ZohoRecruit.modules.candidate.ALL
Possible module names | Possible operation types |
---|---|
Candidates | ALL - Full access to the record WRITE - Edit records in the module UPDATE - Update records in the module |
Possible Errors
Error Code | Message | Reason |
---|---|---|
MANDATORY_NOT_FOUND | Mandatory input parameters are missing for the current action. Missing parameters: Candidate ID, Job ID. | Your request is missing mandatory parameters. |
RECORD_LOCKED | This action isn't allowed for locked records. Unlock the record and try again. | The candidate record you are trying to rate is locked. |
INVALID_DATA | The given candidate ID seems to be invalid. | The candidate ID used in the request is invalid. |
BLOCKED_RECORD | You can not perform the current action on restricted candidates (Opt-Out Entities) | The candidate record used seems to have opted-out. |
ID_ALREADY_DELETED | The given candidate id has already been deleted. | The candidate used in the request has been deleted. |
FAILURE | The given Job ID and Candidate ID are invalid | The candidate ID and job ID used in the request are invalid. |
Sample Input
Copied {
"data": [
{
"jobid":100001000000026488,
"ids": [100001000000023058,100001000000023055],
"comments":"Candidate seems like a good fit for this job",
"rating":5.0
}
]
}
Sample Response: SUCCESS
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"jobid": "100001000000026488",
"ids": "[100001000000023054, 100001000000023056]"
},
"message": "Rating updated successfully",
"status": "success"
}
]
}
Sample Response: FAILURE
Copied{
"data": [
{
"code": "FAILURE",
"details": {
"jobid": "100001000000026488",
"ids": "[]",
"error": [
{
"code": "ID_ALREADY_DELETED",
"details": {
"ids": "100001000000023055"
},
"message": "id already deleted",
"status": "error"
},
{
"code": "RECORD_LOCKED",
"details": {
"ids": "100001000000023058"
},
"message": "Actions aren't allowed for locked records. Unlock the record and try again",
"status": "error"
}
]
},
"message": "invalid data",
"status": "error"
}
]
}