Update Candidate

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

Path Parameters

id

string

required

Body

application/json

passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

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"
}

name

string | null

Candidate name

Example:

"Romain Sestier"

first_name

string | null

Candidate first name

Example:

"Romain"

last_name

string | null

Candidate last name

Example:

"Sestier"

email

string | null

Candidate email

Example:

"[e-mail]"

emails

object[] | null

List of candidate emails

Show child attributes

emails.type

string | null

Type of the email

Example:

"personal"

emails.value

string | null

Email value

Example:

"[e-mail]"

social_links

object[] | null

List of candidate social links

Show child attributes

social_links.type

string | null

Type of the social link

Example:

"linkedin"

social_links.url

string | null

URL of the social link

Example:

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

phone

string | null

deprecated

Candidate phone number

Example:

"[phone]"

phone_numbers

object[] | null

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

Show child attributes

phone_numbers.type

enum<string> | null

Type of phone number

Available options:

personal,

work,

mobile,

home,

unknown,

other

phone_numbers.phone

string | null

Phone number string

Example:

"[phone]"

company

string | null

Candidate company

Example:

"Company Inc."

title

string | null

Candidate title

Example:

"Software Engineer"

application_ids

string[] | null

List of candidate application IDs

Example:

[
  "123e4567-e89b-12d3-a456-426614174000",
  "523e1234-e89b-fdd2-a456-762545121101"
]

hired_at

string | null

Candidate hired date

Example:

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

country

string | null

Candidate country

Example:

"United States"

custom_fields

object[] | null

The candidate custom fields

Show child attributes

custom_fields.id

string | null

Unique identifier

Example:

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

custom_fields.remote_id

string | null

Provider's unique identifier

Example:

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

custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

custom_fields.value

The value associated with the custom field.

Example:

"Completed"

custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

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

200

application/json

The candidate was successfully updated.

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"