Skip to main content
POST
Async ingest a single candidate

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:

"jane.doe@example.com"

phone_number
string | null

Candidate phone number (E.164 format)

Example:

"+12065551234"

metadata
Metadata · object | null

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:
data
Data · object | null

Additional candidate data

Response

Successful Response

data
AsyncIngestResponse · object
required

Response after queuing an async ingest job.

meta
Meta · object | null

Optional metadata. Shape varies by endpoint.