Cancel Interview
Purpose
To cancel a scheduled interview through an API request.
Request URL
https://recruit.zoho.com/recruit/v2/Interviews/{record_id}/action/cancel
record_id - The unique ID of the record
Request Method
PUT
Scope
scope=ZohoRecruit.modules.interview.ALL
(or)
scope= ZohoRecruit.modules.interview.UPDATE
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | INVALID_DATA | The module name given seems to be invalid | The data passed through the API request in invalid. |
Note:
Your API call will return a failure response in the following cases;
- If the candidate record is Locked.
- If the scheduled interview is a Recorded Video Interview and the candidate has already submitted their answers.
- If the interview record is involved in a blueprint process.
Sample Request
Copiedcurl--location--request PUT 'https://recruit.zoho.com/recruit/v2/Interviews/100001000000027144/action/cancel'\
--header 'Authorization: Zoho-oauthtoken 1000.f886e8473dfcb1bc88f2cdf6b9fdfb85.19e28f814de3f6957fe632e1a860ca90'\
--header 'Content-Type: application/json'\
--data - raw '{
"data": [{
"reason": "Candidate was a no-show",
"feedback": "The cancellation was confirmed with the candidate and we have documented proof of their consent."
}]
}Sample Response
Copied{
"data": [{
"details": {
"id": "100001000000027144"
},
"message": "interview cancelled successfully",
"status": "success"
}]
}
