Create an application

Creates an application on a job. Provide jobId and exactly one of candidateId or candidate.

Choosing a candidate

  • Use candidateId for a candidate already in your company.
  • Use candidate to provide inline details. If the email matches an existing candidate, JOIN reuses that candidate, applies new tags and ignores the other supplied profile fields.

Initial state and documents

New applications start as ACTIVE in the job’s first review stage. JOIN sets their source. When documents is omitted for an existing candidate, their profile CV and cover letter are carried forward automatically.

Follow the application workflow, then move the application to a stage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Supply exactly one of candidateId and candidate. Supplying both, or neither, is rejected with validation_error.

integer
required

ID of the job to apply to. The job must not be archived

string
length between 1 and 50
\S

Your own reference for this application. Limited to 50 characters; a longer value is refused with validation_error. Must contain at least one non-whitespace character.

integer

ID of an existing candidate in your company. Either supply this field or candidate, not both

candidate
object

A candidate described inline. When the email is already known to your company, that candidate is reused rather than the request being refused. Either supply this field or candidateId, not both

documents
array of objects

Documents for this application. When omitted, an existing candidate’s profile CV and cover letter are carried forward; no other document type is

documents
Headers
string

Selects a dated API revision in YYYY-MM-DD format, such as 2026-11-01. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json