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

Body

application/json

passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

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

Show child attributes

application_status.value

enum<string> | null

The status of the application.

Available options:

active,

assessment,

background_check,

converted,

declined_by_candidate,

hired,

interview,

lead,

offer,

reference_check,

rejected,

review,

screen,

new,

onboarding,

created,

accepted,

short_list,

approved,

unmapped_value

Example:

"hired"

application_status.source_value

The source value of the application status.

Example:

"Hired"

questionnaires

object[] | null

Questionnaires associated with the application

Show child attributes

questionnaires.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

questionnaires.answers

object[] | null

Show child attributes

questionnaires.answers.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

questionnaires.answers.type

object

Type of the answer

Show child attributes

questionnaires.answers.type.value

enum<string> | null

The type of the answer.

Available options:

short_text,

long_text,

attachment,

multi_select,

single_select,

boolean,

number,

date,

video

Example:

"short_text"

questionnaires.answers.type.source_value

The source value of the answer type.

Example:

"Short Text"

questionnaires.answers.values

string[] | null

Values of the answer

Example:

[
  "Yes",
  "No Travel",
  "It sounds pretty cool.",
  "Excel",
  "Power Point"
]

Example:

{
  "id": "right_to_work",
  "answers": [
    {
      "id": "answer1",
      "type": "text",
      "values": ["Yes"]
    }
  ]
}

source

object

Show child attributes

source.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

source.name

string | null

The source of the application

Example:

"LinkedIn"

candidate_id

string | null

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

Example:

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

candidate

object

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

Show child attributes

candidate.passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

candidate.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

candidate.phone_number

string | null

deprecated

The candidate personal phone number

Example:

"[phone]"

candidate.phone_numbers

object[] | null

List of candidate phone numbers including the type of the number when available

Show child attributes

candidate.phone_numbers.type

enum<string> | null

Type of phone number

Available options:

personal,

work,

mobile,

home,

unknown,

other

candidate.phone_numbers.phone

string | null

Phone number string

Example:

"[phone]"

candidate.name

string | null

Candidate name

Example:

"Romain Sestier"

candidate.first_name

string | null

Candidate first name

Example:

"Romain"

candidate.last_name

string | null

Candidate last name

Example:

"Sestier"

candidate.email

string | null

Candidate email

Example:

"[e-mail]"

candidate.social_links

object[] | null

List of candidate social links

Show child attributes

candidate.social_links.type

string | null

Type of the social link

Example:

"linkedin"

candidate.social_links.url

string | null

URL of the social link

Example:

"https://www.linkedin.com/in/romainsestier/"

candidate.company

string | null

Candidate company

Example:

"Company Inc."

candidate.title

string | null

Candidate title

Example:

"Software Engineer"

candidate.hired_at

string | null

Candidate hired date

Example:

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

candidate.country

string | null

Candidate country

Example:

"United States"

candidate.custom_fields

object[] | null

The candidate custom fields

Show child attributes

candidate.custom_fields.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

candidate.custom_fields.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

candidate.custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

candidate.custom_fields.value

The value associated with the custom field.

Example:

"Completed"

candidate.custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

candidate.custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

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

Response

201

application/json

The application was created successfully.

statusCode

number

required

Example:

201

message

string

required

Example:

"Record created successfully."

timestamp

string

required

Example:

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

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"