Create Candidate

post https://api.paradox.ai/api/v1/public/candidates

Create a new candidate

Body Params

name

string

required

Full name of the candidate (Char limit 50)

first_name

string

First name of the candidate (pass first_name and last_name field if don't pass name field) (Combined Char Limit of 50 with Last Name)

last_name

string

Last name of the candidate (pass first_name and last_name field if don't pass name field) (Combined Char Limit of 50 with First Name)

phone

string

required

Phone number of the candidate (It will required if Email is not inputted) Country Code is required. (Char limit 20)

string

required

Email address of the candidate (It will required if Phone is not inputted) (Char limit 50)

ex_id

string

External Candidate ID (Char limit 255)

hirevue_link

string

HireVue link to do virtual interviews (Char limit 255)

pymetrics_link

string

Pymetrics link to do virtual interviews (Char limit 255)

ex_step

string

External Candidate Step (Char Limit None)

ex_status

string

External Candidate Status (Char Limit None)

ex_reason

string

External Candidate Reason (Char Limit None)

job_req_id

string

Job Req ID (Char limit 255)

job_title

string

Job title (Char limit 255)

job_loc_code

string

Location code of job. (max length : 20)

primary_contact_method

string

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

hired_date

date-time

Hired date time

adp_link

string

Adp link (Char limit 255)

audience_type

string

Blue Collar|White Collar|Blue Collar & White Collar (Char limit 255)

hm_cid

string

Hirescore candidate ID (Char limit 255)

external_group_id

string

External Group ID (Char Limit None)

hirevue_instructions

string

HireVue instructions for virtual interviews (Char limit 255)

referrer_email

string

Referrer's Email (Char limit 50)

referrer_name

string

Referrer's Name (Char limit 50)

recruiter_email

string

The candidate's assigned recruiter

hiring_manager

string

"hiring_email" functions the same. The candidates assigned Hiring Manager

external_referrer

string

External referrer (Char limit 1000)

talent_community

boolean

Defaults to false

Candidate to be added to Paradox Talent Community.

language_preference

string

Defaults to en

Language code preference: ITALIAN = 'it_it' JAPANESE = 'ja_jp' KOREAN = 'ko_kr' PORTUGUESE_BRAZIL = 'pt_br' SIMPLIFIED_CHINESE = 'zh_cn' SPANISH = 'es' TRADITIONAL_CHINESE = 'zh_tw' TURKISH = 'tr_tr' ENGLISH = 'en' FRENCH = 'fr_fr' RUSSIAN = 'ru_ru' GERMAN = 'de_de' FRENCH_CANADIAN = 'fr_ca' DUTCH = 'nl_nl' HUNGARIAN = 'hu' VIETNAMESE = 'vi' BOSNIAN = 'bs' HEBREW = 'he'

candidatedata

file

Report file for do bulk create/update candidates

consent_to_marketing

string

The candidate's consent to marketing

resume

string

Binary/Base64 String Resume file (.pdf, .doc', .docx, .png, .jpg', .txt') (Must be <10mb)

candidate_journey

string

Candidate journey name (Char limit None)

candidate_journey_status

string

Candidate journey status ( {Candidate_journey_stage_name}: {Candidate_journey_status_name} (Char limit None)

candidate_attribute_data

json

Dictionary candidate attribute data (Custom Attributes Char limit 255) Example: {"key_name": "value", "key_name2": "value"}

note

string

Candidate's note (Char limit None)

job_application_id

string

Job Application id (Char limit 255)

use_application_id_for_identity

boolean

Defaults to false

To identify Returning Candidates

candidate_location_info

string

The candidate's location (Char limit 100)

external_source_id

string

The candidate's external_source_id (Char limit 255)

offer_letter

string

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

offer_file_name

string

Offer file name (Char limit 150)

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

Headers

Authorization

string

Defaults to Bearer <oauth_token>

Responses

200200

400400