Create hotlist
A new candidate hotlist, optionally linked to a job.
POST https://cotlet.dev/api/v1/jobdiva/hotlists
write
Returns the hotlist_id for add_candidates_to_hotlist. Linking a job puts the hotlist on that job. It shares the hotlist with nobody, so it does not wait for your OK.
Parameters
| Name | Type | Description |
|---|---|---|
| name string required | string | Hotlist name. |
| description string required | string | What the hotlist is for. |
| job_id integer | integer | Job to link the hotlist to. |
Request
curl -X POST https://cotlet.dev/api/v1/jobdiva/hotlists \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Jane Doe","description":"description"}'result = client.call("jobdiva", "create_hotlist", {"name":"Jane Doe","description":"description"})const result = await cotlet.call('jobdiva', 'create_hotlist', {"name":"Jane Doe","description":"description"});cotlet call jobdiva create_hotlist --data '{"name":"Jane Doe","description":"description"}'Example response
{
"hotlist_id": 88314,
"name": "Senior Data Analyst - Northwind",
"job_id": 24071835,
"status": "created"
}