Add candidate
Create a candidate with a name and optional email, phone, company and title.
POST https://cotlet.dev/api/v1/recruiterflow/candidates
write
Creates one candidate, as the Add Candidate form does. The name is the only required field. Before saving, Recruiterflow checks for an existing record that matches on phone number, LinkedIn URL or email; on a match the call creates nothing and returns the existing candidate_id with status duplicate. A new candidate is on no job until you pass job_id or call add_candidate_to_job. The tool sends no message itself. It reaches no one, but Cotlet has no delete tool, so check the name before calling.
Parameters
| Name | Type | Description |
|---|---|---|
| name string required | string | Full name. |
| email string | string | Email address. |
| phone string | string | Phone number. |
| current_company string | string | Current company. |
| job_title string | string | Current job title. |
| job_id string | string | Also add the candidate to this open job. |
Request
curl -X POST https://cotlet.dev/api/v1/recruiterflow/candidates \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Jane Doe"}'result = client.call("recruiterflow", "add_candidate", {"name":"Jane Doe"})const result = await cotlet.call('recruiterflow', 'add_candidate', {"name":"Jane Doe"});cotlet call recruiterflow add_candidate --data '{"name":"Jane Doe"}'Example response
{
"candidate_id": "772455",
"status": "created",
"name": "Elena Rossi",
"job": null,
"url": "https://recruiterflow.com/candidates/772455"
}