Update an existing candidate

post

https://api02.naturalhr.net/api/v1/candidate/{candidate_id}

Path Params

candidate_id

int32

required

Natural HR system ID for the candidate Lookup value

Body Params

post_applied_for

int32

Natural HR system ID for the post being applied for Lookup value

post_reference

string

Your internal reference for the post

date_received

date

Date the candidate application was received (yyyy-mm-dd)

title

string

Candidate title (e.g. Mr, Mrs etc)

surname

string

Candidate surname

firstname

string

Candidate firstname

othername

string

Candidate other names

dob

date

Candidate date of birth (yyyy-mm-dd)

national_insurance

string

Candidate national insurance / social security number

nationality

string

Candidate nationality - must be valid based on Natural HR list of valid nationalities Expected value

marital_status

string

Candidate marital status Marital status

address

string

Candidate address line 1

address2

string

Candidate address line 2

town

string

Candidate address town / city

county

string

Candidate address county / state

postcode

string

Candidate address post code / zip code

country

string

Candidate address country Expected value

home_tel

string

Candidate home telephone

mobile

string

Candidate mobile telephone

string

Candidate email address - must be a valid email address

file

Candidate CV / resume file - should be less than 2MB and either pdf, doc, rtf or txt format

right_to_work

int32

Candidate right to work status Yes/No

driving_license

int32

Candidate driving license status Yes/No

access_car

int32

Candidate access to car status Yes/No

gender

string

Candidate gender Genders

dependants

int32

Candidate dependants Yes/No/Not given

ethnicity

string

Candidate nationality Expected value

disability

string

Candidate disability status Yes/No/Not given

active

int32

Candidate status Active

comments

string

Candidate comments

entered_by

int32

Natural HR system ID for the person who added the candidate Lookup value

entered_stamp

date

Date and time the candidate was entered into the system (yyyy-mm-dd H:i:s)

employed

int32

Is the candidate now an employee? Yes/No

stage

int32

Natural HR system ID for the stage the candidate is currently in Lookup value

cv_text

string

Parsed text of the candidates CV

customq_1

string

Text of company custom question 1

customa_1

string

Candidate answer to company custom question 1

customq_2

string

Text of company custom question 2

customa_2

string

Candidate answer to company custom question 2

customq_3

string

Text of company custom question 3

customa_3

string

Candidate answer to company custom question 3

customq_4

string

Text of company custom question 4

customa_4

string

Candidate answer to company custom question 4

customq_5

string

Text of company custom question 5

customa_5

string

Candidate answer to company custom question 5

customq_6

string

Text of company custom question 6

customa_6

string

Candidate answer to company custom question 6

customq_7

string

Text of company custom question 7

customa_7

string

Candidate answer to company custom question 7

customq_8

string

Text of company custom question 8

customa_8

string

Candidate answer to company custom question 8

customq_9

string

Text of company custom question 9

customa_9

string

Candidate answer to company custom question 9

customq_10

string

Text of company custom question 10

customa_10

string

Candidate answer to company custom question 10

available_date

date

Date the candidate will be available (yyyy-mm-dd)

starred

int32

Candidate starred Yes/No

new

int32

Candidate new - 0 - No, 1 - Yes. Defaults to 1

recruiter_id

string

Unique code for recruiter - must be valid recruiter for your company

role_q1

string

Text of role question 1

role_a1

string

Candidate answer to role question 1

role_q2

string

Text of role question 2

role_a2

string

Candidate answer to role question 2

role_q3

string

Text of role question 3

role_a3

string

Candidate answer to role question 3

role_q4

string

Text of role question 4

role_a4

string

Candidate answer to role question 4

role_q5

string

Text of role question 5

role_a5

string

Candidate answer to role question 5

referrer_domain

string

Domain name for referrer for candidate - e.g. www.linkedin.com

archived_date

date

Date the candidate was archived (yyyy-mm-dd)

managers_visible

int32

Is candidate visible to hiring managers? Yes/No

traffic_light

int32

Employee traffic light status Traffic light

Responses

200200

400400