Update Candidate

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

Update a single candidate

Results

Update a specific candidate by calling this endpoint.

The result contains the following keys:

Key	Description
*candidate*	*Candidate information*
start_keyword	Keyword text used by candidate to initiate the conversation
phone_number	phone number of the candidate
email	email address of the candidate
updated_at	Last timestamp when candidate was updated
formatted_number	candidate's phone number in E.164 format (+12144930945)
edited_name	edited name of the candidate
created_at	timestamp when candidate was created
OID	id of the Olivia candidate
name	full name of the candidate
source	Possible values include SMS = 1, WIDGET = 2, RECRUITER_PAGE = 3, COMPANY_PAGE = 4, EMBEDDED_WIDGET = 5, WIT_WIDGET = 6
group_name	group name of the candidate
external_oid	encrypted id of the Olivia candidate
referrer_email	Referrer's Email
referrer_name	Referrer's Name
external_referrer	External referrer
language_preference	Language code preference
*conversation*	*List conversation*
media_url	URL of the image/video sent by the candidate
message_type	Possible values include FREE_TEXT = 1, TK_TEXT = 2, ASK_ANY_THING_TEXT = 3, ASK_CONTINUE_TEXT = 4, PROMPT_NAME = 5, PROMPT_EMAIL = 6, PROMPT_PHONE = 7, ASK_DATA = 8, ASK_DOCUMENT = 9, ASK_LIST_SELECT = 10
answer_text	answer text from Olivia / company user
updated_at	Last timestamp when conversation was updated
question_text	question text asked by the candidate
from_who	if 0, the reply was from the AI. Else, id of the company_user
created_at	timestamp when conversation was created
*interview*	*Interview information*
past_interview_at	timestamp of the last completed interview
scheduled_at	timestamp of the interview
interviewed	if 1, the candidate was already interviewed
scheduled_by	id of the company user who scheduled the interview with the candidate
interview_location_id	Location ID that will be interview
*stage*	*Stages of candidte*
viewed	if 1, the candidate was viewed by a company user
completed	if 1 the candidate completed the conversation
is_live	if 1 the candidate is on a live conversation
responded	if 1 the candidate has been responded to by a company user
status	Possible values include APPROVED = 1, PENDING = 2, ARCHIVED = 3, DRAFT = 4, SPAM = 5, UNKNOWN = 7, SCHEDULED = 8, CONFIRMED = 9, REMOVED = 10
interview_stage	Possible values include NONE = 1, PENDING = 2, SCHEDULED = 3, SCHEDULE = 4, PENDING_INVITE = 5, PENDING_OPT_IN_REQUEST = 6, PENDING_INVITE_SMS_BS_HOUR = 7, NO_AVAILABILITY = 8, CANCELED = 9, CANCELED_REQUEST = 10

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

Results

200200

400400