Set candidate status
Change a candidate to in progress, on hold, rejected, withdrawn or hired.
PUT https://cotlet.dev/api/v1/comeet/candidates/{candidate_id}/status
Sets the status as the status list on the profile does. rejected and withdrawn need last_step, the last completed workflow step; for a Go/No Go or Interview step pass completed_by, the participants of that step. reason is one of your disposition reasons, and is required when your company made them required. hired needs opening, application_date and first_day. A change from in progress cancels future scheduled interviews. notify decides whether the candidate hears about a rejection: none (default), create_send_notification_step or send_message. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| candidate_id string required | string | Candidate from list_candidates. |
| status enum required | enum | in_progress, on_hold, rejected, withdrawn or hired. |
| last_step string | string | Last completed step; required for rejected and withdrawn. |
| completed_by array | array | Participants who completed a Go/No Go or Interview last step. |
| reason string | string | Disposition reason text, e.g. Incomplete application. |
| note string | string | Optional note stored with the reason. |
| notify enum | enum | none (default), create_send_notification_step or send_message. |
| opening string | string | Opening the hire fills; required for hired. |
| application_date date | date | When the hiring process began; required for hired. |
| first_day date | date | First day of work; required for hired. |
Request
curl -X PUT https://cotlet.dev/api/v1/comeet/candidates/cand_7d21a9/status \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"status":"rejected","last_step":"Application review","reason":"Incomplete application","note":"No portfolio link in the application."}'result = client.call("comeet", "set_candidate_status", {"candidate_id":"cand_7d21a9","status":"rejected","last_step":"Application review","reason":"Incomplete application","note":"No portfolio link in the application."})const result = await cotlet.call('comeet', 'set_candidate_status', {"candidate_id":"cand_7d21a9","status":"rejected","last_step":"Application review","reason":"Incomplete application","note":"No portfolio link in the application."});cotlet call comeet set_candidate_status --data '{"candidate_id":"cand_7d21a9","status":"rejected","last_step":"Application review","reason":"Incomplete application","note":"No portfolio link in the application."}'Example response
{
"candidate_id": "cand_7d21a9",
"name": "Noah Kim",
"position": "Senior Product Designer",
"status": "rejected",
"last_step": "Application review",
"reason": "Incomplete application",
"note": "No portfolio link in the application.",
"notified": "none",
"cancelled_interviews": 0
}