Skip to main content
POST
/
api
/
v2
/
postings
/
{posting_id}
/
candidates
/
async
Async ingest a single candidate
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": "+12065551234",
  "metadata": {
    "ats_stage": "phone_screen",
    "external_id": "candidate_xyz"
  },
  "data": {}
}
'
{
  "data": {
    "ingestion_id": "<string>",
    "object": "ingestion",
    "status": "queued"
  },
  "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
name
string
required

Candidate full name

Example:

"Jane Doe"

email
string
required

Candidate email address

Example:

"jane.doe@example.com"

phone_number
string | null

Candidate phone number (E.164 format)

Example:

"+12065551234"

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.

Example:
{
"ats_stage": "phone_screen",
"external_id": "candidate_xyz"
}
data
Data · object

Additional candidate data

Response

Successful Response

data
AsyncIngestResponse · object
required

Response after queuing an async ingest job.

meta
Meta · object

Optional metadata. Shape varies by endpoint.