v1
latestOpenAPI 3.1.02026-08-0456127224.3 KBCandidates
Bulk ingest candidates
Submit multiple candidates at once for processing through the interviewer's workflow. Returns an interview ID and URL for each candidate.
post/api/v2/postings/{posting_id}/candidates/bulk
Path parameters
posting_idstring required
Headers
X-API-KEYstring nullable
Authorizationstring nullable
X-Workspace-Idstring nullable
Request body
Example request
{
"data": [
{
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone_number": "+12065551234",
"metadata": {
"ats_stage": "phone_screen",
"external_id": "candidate_xyz"
}
}
]
}Response
Successful Response
Example response
{
"data": [
{
"interview_id": "D536A69A4090E13F",
"interview_url": "https://candidates.heymilo.io/acme/i/D536A69A4090E13F",
"metadata": {
"ats_stage": "phone_screen",
"external_id": "candidate_xyz"
}
}
]
}