Update Candidate

put

https://api.paradox.ai/api/v1/public/candidates/{ID}

Update a single candidate

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Either: OID or external_oid or ex_id

Body Params

phone

string

Phone number of the candidate

string

Email address of the candidate

name

string

Full name (first and last) of the candidate

first_name

string

First name of the candidate (pass first_name and last_name field if don't pass name field)

last_name

string

Last name of the candidate (pass first_name and last_name field if don't pass name field)

status

string

Status of the candidate (APPROVED = 1, PENDING = 2, ARCHIVED = 3, DRAFT = 4, SPAM = 5)

location

string

Location of the candidate

hirevue_link

string

HireVue link to do virtual interviews

pymetrics_link

string

Pymetrics link to do virtual interviews

ex_step

string

External Candidate Step

ex_status

string

External Candidate Status

ex_reason

string

External Candidate Reason

job_req_id

string

Job Req ID

job_title

string

Job Title

primary_contact_method

string

1 = Email, 2 = SMS, 3 = Email & SMS, 4 = WhatsApp & Email. Default = Email & SMS

hired_date

string

Hired date time

adp_link

string

Adp link

audience_type

string

Blue Collar|White Collar|Blue Collar & White Collar

hm_cid

string

Hirescore Candidate ID

external_group_id

string

External Group ID

hirevue_instructions

string

HireVue instructions for virtual interviews

referrer_email

string

Referrer's Email

referrer_name

string

Referrer's Name

external_referrer

string

External referrer

language_preference

string

Defaults to en

Language code preference

resume

string

Binary/Base64 String Resume file (.pdf, .doc', .docx, .png, .jpg', .txt')

candidate_journey

string

Candidate journey name

candidate_journey_status

string

Candidate journey status ( {Candidate_journey_stage_name}: {Candidate_journey_status_name}

candidate_attribute_data

json

Dictionary candidate attribute data. Example: {"key_name": "value", "key_name2": "value"}

note

string

Candidate's note

candidate_location_info

string

The candidate's location

external_source_id

string

The candidate's external_source_id

offer_letter

string

Binary/Base64 String Offer file (.doc, .docx, .pdf, .png, .jpg, .jpeg, .txt, .pages, .HTML)

offer_file_name

string

Offer file name

use_paradox_status_map

boolean

Defaults to false

To identify the use of status_map_name and status_map_ex_id

status_map_name

string

Name of the Journey Status Mapping in Paradox. Required when use_paradox_status_map is true

status_map_ex_id

string

Name of the status in the external system. The ID that is associated with a specific Journey Status in Paradox. Required when use_paradox_status_map is true

Headers

Authorization

string

Defaults to Bearer <oauth_token>

Responses

200200

400400