Custom Fields

You can update candidate custom fields by using the generated internal_name of the applicant field that you have in PeopleForce. This unique field name is automatically generated when you create a custom
field, and is returned by the GET /candidate_fields endpoint.

For example, if you have a field labelled "Tax number" in PeopleForce, it will have an autogenerated internal name called tax_number. You can then use it within your request as a top-level attribute alongside other system attributes of the candidate, for example full_name:

{                                                                                                                                                                                                             
  "full_name": "Andrew",                                                                                                                                                                                         
  "tax_number": "123123"                                                                                                                                                                                         
}

For Select fields, pass the option value as a string. For MultiSelect fields, pass an array of option values:

{                                                                                                                                                                                                                
  "full_name": "Andrew",                                                                                                                                                                                         
  "department_preference": "Engineering",                                                                                                                                                                        
  "spoken_languages": ["English", "Spanish"]                                                                                                                                                                     
}