Send candidates to a client
Email candidates to the client as a LiveList for a job and move them to Sent.
POST https://cotlet.dev/api/v1/vincere/jobs/{job_id}/candidates-to-clients
write Confirm
Sends a LiveList for one job to its client, using Vincere's template 2.5 Send Candidate List, and moves the applications to the Sent stage. hide_names hides candidate names and current employers. message replaces the email body and extra_recipients adds addresses. Vincere limits one email action to 100 recipients. The email reaches the client and cannot be recalled. 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_ids array required | array | Candidate ids on that job, from list_job_applications. |
| include_attachments boolean | boolean | Attach the candidates' documents. Default: false. |
| hide_names boolean | boolean | Hide candidate names and current employers from the client. Default: false. |
| message string | string | Replaces the body of the email template. |
| extra_recipients array | array | Email addresses to add to the job contact. |
Request
curl -X POST https://cotlet.dev/api/v1/vincere/jobs/1042/candidates-to-clients \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"candidate_ids":["88214","88230","88251"],"include_attachments":true,"hide_names":false}'result = client.call("vincere", "send_candidates_to_client", {"job_id":"1042","candidate_ids":["88214","88230","88251"],"include_attachments":True,"hide_names":False})const result = await cotlet.call('vincere', 'send_candidates_to_client', {"job_id":"1042","candidate_ids":["88214","88230","88251"],"include_attachments":true,"hide_names":false});cotlet call vincere send_candidates_to_client --data '{"job_id":"1042","candidate_ids":["88214","88230","88251"],"include_attachments":true,"hide_names":false}'Example response
{
"job_id": "1042",
"sent": [
{
"candidate_id": "88214",
"name": "Priya Nair",
"stage": "sent"
},
{
"candidate_id": "88230",
"name": "Tomas Wu",
"stage": "sent"
},
{
"candidate_id": "88251",
"name": "Lena Ortiz",
"stage": "sent"
}
],
"template": "2.5 - Send Candidate List",
"recipients": [
"alex.reed@brightline.example"
],
"names_visible": true,
"attachments_included": true
}