Update Candidate

Update Candidate

PUT

Nested custom-field value policy

When the request contains linked parent and child custom fields, use invalid_linked_custom_field_value_policy to control what happens when a child value is hidden by, or does not match, its effective parent value.

Value	Behaviour
`keep`	Preserves invalid child values. This is the default when the property is omitted.
`clear`	Stores invalid non-file child values as `null`. File values are always retained.

The operation completes successfully under either policy. A child-only update is evaluated against the parent value already stored on the record. A parent update also re-evaluates its descendants.

JSON example

{
  "invalid_linked_custom_field_value_policy": "clear",
  "custom_fields": [
    { "id": 12, "value": "EMEA" },
    { "id": 13, "value": "Germany" }
  ]
}

Custom-field request IDs are the public IDs returned as id by GET /v1/custom-field. Use that endpoint to discover each child field's dependency, including the parent field's public parent_field_id, the visible_when values that make the child visible, and any allowed_child_options for dropdown or multiselect child fields.

The response envelope and entity response fields are unchanged; only the resulting child value may be retained or returned as null according to the selected policy.

Update the details of an existing candidate by their unique slug.

Request

PUT

PUT /v1/candidate/:slug

Path Parameter

slugstring
Replace :slug with the candidate's unique slug in the request URL.

Body

first_namestring
>= 1 characters (required)
last_namestring
>= 1 characters (required)
gender_idinteger
Allowed Values:
0 => Not Available,
1 => Male,
2 => Female
emailstring
>= 1 characters
phonestring
>= 1 characters
date_of_birthstring
Format: YYYY-MM-DD (e.g., 1990-01-01)
resumefile
owner_idinteger
required
created_byinteger
citystring
>= 1 characters
statestring
>= 1 characters
countrystring
>= 1 characters
language_idsstring
Comma-separated values:- [1,2,3]
skillstring
Comma-separated values:- [PHP,MySql,ReactJS]
sourcestring
>= 1 characters
addressstring
>= 1 characters
current_positionstring
>= 1 characters
experienceinteger
graduation_datestring
Format: YYYY-MM-DD (e.g., 1990-01-01)
current_salarynumber
notice_periodinteger
salary_typeinteger
Salary type of the candidate.
Allowed Values:
1 => "Annual",
2 => "Monthly",
3 => "Weekly",
4 => "Daily",
5 => "Hourly"
expected_salarynumber
nationalitystring
>= 1 characters
descriptionstring
>= 1 characters
profile_xing_urlstring
>= 1 characters
profile_linkedin_urlstring
>= 1 characters
last_organizationstring
>= 1 characters
current_organizationstring
>= 1 characters
education_specializationstring
>= 1 characters
qualification_idinteger
universitystring
>= 1 characters
industry_idinteger
currency_idinteger
willing_to_relocateinteger
Is the candidate willing to relocate?
Allowed Values:
"1" => Yes,
"0" => No
available_fromstring
Format: YYYY-MM-DD (e.g., 1990-01-01)
tagsstring
Comma-separated values:- [Java,Leadership]
custom fields:Array[object]
For Example:
"id": 1,
"value": "textfeild"
invalid_linked_custom_field_value_policystring
Optional. Allowed values: keep, clear. Default: keep. Controls whether invalid linked child custom-field values are retained or cleared.

Response

201

Body

idnumber
Example: 48
first_namestring
Example: John
last_namestring
Example: Doe
slugstring
Example: candidate_0d25558c1a77fc2d7d98
full_namestring
Example: John Doe
emailstring
Example: johndoe@example.com
phonestring
Example: 1234567890
resumestring
Example: resume.pdf
profile_picturestring
Example: anjali.jpg
education_specializationstring
Example: Computer Science
universitystring
Example: Harvard University
current_positionstring
Example: Software Engineer
current_organizationstring
Example: XYZ Inc
last_organizationstring
Example: ABC Corp
willing_to_relocatenumber
Example: 0
available_fromstring
Example: 2024-09-01
tagsstring
Example: [frontend, developer, javascript]
skillstring
Example: [JavaScript, React]
experiencenumber
Example: 5
graduation_datestring
Example: 2015-05-15
current_salarynumber
Example: 70000
expected_salarynumber
Example: 90000
notice_periodnumber
Example: 30
salary_typeinteger
Example: 1
descriptionstring
Example: Experienced software engineer with a focus on frontend development.
sourcestring
Example: LinkedIn
nationalitystring
Example: American
addressstring
Example: 123 Main St
languagestring
Example: Hindi
citystring
Example: Indore
statestring
Example: Madhya Pradesh
countrystring
Example: USA
industryinteger
Example: 1
genderobject
Example:
"id": 1,
"label": "female"
ownerobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
currencyobject
Example:
"id": 1,
"country": "usa",
"code": "ALL",
"currency": "dollar",
"symbol": "$"
qualificationstring
Example: btech
socialsobject
Example:
"linked_in": "https://www.linkedin.com/in/johndoe",
"xing": "https://www.xing.com/profile/John_Doe"
created_atstring (ISO 8601 date)
Example: 2015-05-15T00:00:00Z
updated_atstring (ISO 8601 date)
Example: 2015-05-15T00:00:00Z
created_byobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
updated_byobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
custom fields:object
Example:
"id": 1,
"field_name": "textfeild",
"field_type": "string",
"value": "anjali"

401

Body

unauthorised

400

Body

Unprocessable Entity

Response Example

{
  "id": 51,
  "first_name": "Jo",
  "last_name": "Doe",
  "slug": "candidate_732999f1fc491eebbed0",
  "full_name": "Jo Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "resume": "",
  "profile_picture": "",
  "education_specialization": "",
  "university": "",
  "current_position": "",
  "current_organization": "",
  "last_organization": "",
  "willing_to_relocate": 0,
  "available_from": null,
  "tags": "",
  "skill": "",
  "experience": 5,
  "graduation_date": null,
  "current_salary": 0,
  "expected_salary": 80000,
  "notice_period": 1,
  "salary_type": null,
  "description": "",
  "source": "",
  "nationality": "",
  "address": "123 Main St, Anytown, USA",
  "language": "",
  "city": "Anytown",
  "state": "NY",
  "country": "USA",
  "industry": 0,
  "gender": {
    "id": 0,
    "label": "Not Available"
  },
  "owner": {
    "id": 1,
    "email": "Rohan@abc.com",
    "first_name": "Rohan",
    "last_name": "Sharma",
    "full_name": "Rohan Sharma",
    "role": "Admin",
    "phone": null
  },
  "currency": {
    "id": 1,
    "country": "Albania",
    "code": "ALL",
    "currency": "Leke",
    "symbol": "Lek"
  },
  "qualification": 0,
  "socials": {
    "linkedin": "",
    "xing": ""
  },
  "created_at": "2024-08-23T16:51:23.000Z",
  "updated_at": "2024-08-23T16:51:51.000Z",
  "created_by": {
    "id": 1,
    "email": "Rohan@abc.com",
    "first_name": "Rohan",
    "last_name": "Sharma",
    "full_name": "Rohan Sharma",
    "role": "Admin",
    "phone": null
  },
  "updated_by": {
    "id": 1,
    "email": "Rohan@abc.com",
    "first_name": "Rohan",
    "last_name": "Sharma",
    "full_name": "Rohan Sharma",
    "role": "Admin",
    "phone": null
  },
  "custom_fields": [
    {
      "id": 1,
      "field_name": "C Text asasa",
      "field_type": "text",
      "value": "Some custom value"
    },
    {
      "id": 2,
      "field_name": "C Date",
      "field_type": "date",
      "value": null
    }
  ]
}

Nested custom-field value policy

Request​

PUT

Path Parameter

Body

Response​

Body

Body

Body

Response Example​

Request

Response

Response Example