Async ingest a single candidate

Queue a candidate for async processing through the interviewer’s workflow. Returns an ingestion ID to track the job.

POST /api/v2/postings/{posting_id}/candidates/async

Async ingest a single candidate

cURL

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

202

{
  "data": {
    "ingestion_id": "<string>",
    "object": "ingestion",
    "status": "queued"
  },
  "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

name · string · required

Candidate full name

Example:

"Jane Doe"

email · string · required

Candidate email address

Example:

"[e-mail]"

phone_number · string | null

Candidate phone number (E.164 format)

Example:

"[phone]"

metadata · Metadata · object

Set of key-value pairs for storing additional information on the candidate. Up to 50 keys, each key max 40 chars, each value max 500 chars.

Show child attributes

Example:

{
  "ats_stage": "phone_screen",
  "external_id": "candidate_xyz"
}

data · Data · object

Additional candidate data

Response

202

application/json

Successful Response

data · AsyncIngestResponse · object · required

Response after queuing an async ingest job.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.