Skip to main content
POST
Create Application

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
passthrough
object | null

Value to pass through to the provider

Example:
job_id
string | null

Unique identifier of the job

Example:

"4071538b-3cac-4fbf-ac76-f78ed250ffdd"

job_posting_id
string | null

Unique identifier of the job posting that is associated with application

Example:

"1c702a20-8de8-4d03-ac18-cbf4ac42eb51"

location_id
string | null

Unique identifier of the location

Example:

"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"

application_status
object | null
questionnaires
object[] | null

Questionnaires associated with the application

Example:
source
object | null
candidate_id
string | null

Unique identifier of the candidate. Provide this OR candidate, but not both.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

candidate
object | null

Candidate Properties. Provide this OR candidate_id, but not both. Providing this attempts to create a new candidate with the application.

documents
object[] | null

Document Properties. Providing this attempts to upload files with the application.

Response

The application was created successfully.

statusCode
number
required
Example:

201

message
string
required
Example:

"Record created successfully."

timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

data
object
required