Candidate Update

PATCH /candidate/{id}

This API is to update candidate using id. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

Content-Type string Required

application/json
Accept string Required

application/json

Path parameters

id string Required

application/json

Body

first_name string
last_name string
email string
has_contact_profile_view boolean

Default value is true.
address_line1 string
place string
post_code string
mobile_prefix string
mobile_number string
preferred_name string
employment_types_id integer
employment_type_company_id integer
dbs_pvg_no string
dbs_issue_date string(date)
dbs_exp_date string(date)
next_check_date string(date)
nmc_pin_number string
nationality string
dob string(date)
place_of_birth string
gender string

Values are male, female, or other.
is_driver boolean

Default value is false.
nappi_trained boolean

Default value is false.
medication_trained boolean
weekly_hours string
selected_profile_job array[integer]
jobs array[integer]
regions array[integer]
ni_number string
tax_code string
payroll_id string
payroll_job_status string

Values are nil, First Job 6th April, I have another job, Student Loan, or This is my only job.
payroll_frequency string

Values are Weekly, Monthly, or 4 Weekly.
payment_reference string

PATCH /candidate/{id}

curl \
 -X PATCH https://api-console.logezy.co/v1/candidate/{id} \
 -H "Content-Type: string" \
 -H "Accept: string" \
 -d '{"first_name":"string","last_name":"string","email":"string","has_contact_profile_view":true,"address_line1":"string","place":"string","post_code":"string","mobile_prefix":"string","mobile_number":"string","preferred_name":"string","employment_types_id":0,"employment_type_company_id":0,"dbs_pvg_no":"string","dbs_issue_date":"2019-08-24","dbs_exp_date":"2019-08-24","next_check_date":"2019-08-24","nmc_pin_number":"string","nationality":"string","dob":"2019-08-24","place_of_birth":"string","gender":"male","is_driver":false,"nappi_trained":false,"medication_trained":true,"weekly_hours":"string","selected_profile_job":[0],"jobs":[0],"regions":[0],"ni_number":"string","tax_code":"string","payroll_id":"string","payroll_job_status":"nil","payroll_frequency":"Weekly","payment_reference":"string"}'

Request example

# Headers
Content-Type: string
Accept: string

# Payload
{
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "has_contact_profile_view": true,
  "address_line1": "string",
  "place": "string",
  "post_code": "string",
  "mobile_prefix": "string",
  "mobile_number": "string",
  "preferred_name": "string",
  "employment_types_id": 0,
  "employment_type_company_id": 0,
  "dbs_pvg_no": "string",
  "dbs_issue_date": "2019-08-24",
  "dbs_exp_date": "2019-08-24",
  "next_check_date": "2019-08-24",
  "nmc_pin_number": "string",
  "nationality": "string",
  "dob": "2019-08-24",
  "place_of_birth": "string",
  "gender": "male",
  "is_driver": false,
  "nappi_trained": false,
  "medication_trained": true,
  "weekly_hours": "string",
  "selected_profile_job": [
    0
  ],
  "jobs": [
    0
  ],
  "regions": [
    0
  ],
  "ni_number": "string",
  "tax_code": "string",
  "payroll_id": "string",
  "payroll_job_status": "nil",
  "payroll_frequency": "Weekly",
  "payment_reference": "string"
}