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

Bulk ingest candidates

cURL

curl --request POST \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "name": "<string>",
      "email": "<string>",
      "phone_number": "[phone]",
      "metadata": {
        "ats_stage": "phone_screen",
        "external_id": "candidate_xyz"
      },
      "data": {}
    }
  ]
}
'

201

{
  "data": [
    {
      "interview_id": "<string>",
      "interview_url": "<string>",
      "object": "candidate",
      "metadata": {
        "ats_stage": "phone_screen",
        "external_id": "candidate_xyz"
      }
    }
  ],
  "meta": {}
}

Authorizations

X-API-KEY · string · header · required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY · string | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

posting_id · string · required

Body

application/json

data · CandidateIngestRequest · object[] · required

List of candidates to ingest

Minimum array length: 1

Show child attributes

Response

201

application/json

Successful Response

data · BulkIngestCandidateResponseItem · object[] · required

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.