customField.setValue

Set the value of a custom field for a given object.

Note: When updating multiple custom fields on the same object, use customField.setValues instead to avoid race conditions.

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
  • Url - A valid http or https URL (e.g., https://example.com)
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!