Disqualify a candidate
Disqualify a candidate with a reason and choose whether to tell them.
POST https://cotlet.dev/api/v1/homerun/jobs/{job_id}/candidates/{candidate_id}/disqualify
write Confirm
Removes the candidate from the job's list of all candidates and records the reason, which the candidate does not see. With notify email the message goes out at once; with todo Homerun creates a to-do for you instead. A disqualified candidate can be re-qualified in Homerun. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| job_id string required | string | Job ID from list_jobs. |
| candidate_id string required | string | Candidate ID from list_candidates. |
| reason string required | string | A name from list_disqualification_reasons. |
| notify string | string | none, email or todo. Default none. |
| email_body string | string | Message to send when notify is email. |
Request
curl -X POST https://cotlet.dev/api/v1/homerun/jobs/job_3b7e91/candidates/ap_N4pQ8sT2vX6zB1cD3eF5/disqualify \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"reason":"No relevant experience","notify":"none"}'result = client.call("homerun", "disqualify_candidate", {"job_id":"job_3b7e91","candidate_id":"ap_N4pQ8sT2vX6zB1cD3eF5","reason":"No relevant experience","notify":"none"})const result = await cotlet.call('homerun', 'disqualify_candidate', {"job_id":"job_3b7e91","candidate_id":"ap_N4pQ8sT2vX6zB1cD3eF5","reason":"No relevant experience","notify":"none"});cotlet call homerun disqualify_candidate --data '{"job_id":"job_3b7e91","candidate_id":"ap_N4pQ8sT2vX6zB1cD3eF5","reason":"No relevant experience","notify":"none"}'Example response
{
"candidate_id": "ap_N4pQ8sT2vX6zB1cD3eF5",
"status": "disqualified",
"reason": "No relevant experience",
"notified": "none",
"stage_before": "Application"
}