Update an 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

Path Parameters

id

string

required

Body

application/json

passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

custom_fields

object[] | null

The application 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"

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"

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"

Response

200

application/json

Record updated successfully.

statusCode

number

required

Example:

200

message

string

required

Example:

"Record updated successfully."

timestamp

string

required

Example:

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