Skip to main content
POST
Push a candidate to the ATS

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

Body

application/json
ats_name
string
required

ATS provider name (e.g. 'bullhorn').

candidate
PushCandidatePayload · object
required
posting_id
string | null
interview_id
string | null
ingestion_token
string | null
create_submission
boolean
default:false

Also create a candidate-to-job link in the ATS.

Response

Successful Response

data
EnqueuePushResponse · object
required
meta
Meta · object | null

Optional metadata. Shape varies by endpoint.