Invite to self-schedule
Email a candidate a link to pick their interview time.
POST https://cotlet.dev/api/v1/comeet/candidates/{candidate_id}/self-schedule/invite
write Confirm
Does what Schedule > Invite a candidate to select a time does on an interview step. online_meeting is none, zoom or custom_link; custom_link needs the URL, and zoom needs a plan that includes it. The candidate sees your availability at the moment they open the link, and the link expires after 5 days by default. It fails if Auto-scheduling is not configured by an Admin. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| candidate_id string required | string | Candidate at an interview step. |
| step string required | string | Interview step name. |
| online_meeting enum | enum | none (default), zoom or custom_link. |
| custom_link string | string | Video interview URL for custom_link. |
Request
curl -X POST https://cotlet.dev/api/v1/comeet/candidates/cand_3b90e4/self-schedule/invite \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"step":"Interview with hiring manager","online_meeting":"custom_link","custom_link":"https://meet.example.com/northwind/hm-interview"}'result = client.call("comeet", "invite_to_self_schedule", {"candidate_id":"cand_3b90e4","step":"Interview with hiring manager","online_meeting":"custom_link","custom_link":"https://meet.example.com/northwind/hm-interview"})const result = await cotlet.call('comeet', 'invite_to_self_schedule', {"candidate_id":"cand_3b90e4","step":"Interview with hiring manager","online_meeting":"custom_link","custom_link":"https://meet.example.com/northwind/hm-interview"});cotlet call comeet invite_to_self_schedule --data '{"candidate_id":"cand_3b90e4","step":"Interview with hiring manager","online_meeting":"custom_link","custom_link":"https://meet.example.com/northwind/hm-interview"}'Example response
{
"candidate_id": "cand_3b90e4",
"name": "Priya Nair",
"step": "Interview with hiring manager",
"invitation": "sent",
"online_meeting": "custom_link",
"expires_in_days": 5
}