Skip to main content
POST
/
api
/
v2
/
postings
/
{posting_id}
/
candidates
/
bulk
Bulk ingest candidates
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": "+12065551234",
      "metadata": {
        "ats_stage": "phone_screen",
        "external_id": "candidate_xyz"
      },
      "data": {}
    }
  ]
}
'
{
  "data": [
    {
      "interview_id": "<string>",
      "interview_url": "<string>",
      "object": "candidate",
      "metadata": {
        "ats_stage": "phone_screen",
        "external_id": "candidate_xyz"
      }
    }
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
required

Path Parameters

posting_id
string
required

Body

application/json
data
CandidateIngestRequest · object[]
required

List of candidates to ingest

Minimum array length: 1

Response

Successful Response

data
BulkIngestCandidateResponseItem · object[]
required
meta
Meta · object

Optional metadata. Shape varies by endpoint.