API Reference

customField.setValue

Set the value of a custom field

Requires the candidatesWrite permission.

The values accepted in the fieldValue param depend on the type of field that's being updated. See below for more details:

  • Boolean - A boolean value
  • Date - An ISO Date string
  • Email, LongText, Phone, String - String
  • ValueSelect - A string that matches the value of one of the ValueSelect field's options
  • MultiValueSelect - An array of strings that exist in the MultiValueSelect field's options
  • Number - A number
  • NumberRange - An object with the following properties:
    • type: "number-range"
    • minValue: A number
    • maxValue: A number
  • CompensationRange - An object with the following properties:
    • type: "compensation-range"
    • minValue: A number
    • maxValue: A number
    • currencyCode: A string
    • interval: A valid interval string
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!