customField.setValues

Set the values of multiple custom fields for a given object in a single call. This is the recommended approach when updating multiple fields on the same object to avoid race conditions that can occur with concurrent customField.setValue calls.

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)
  • UUID - A valid UUID string (e.g., for Employee fields)
Body Params
uuid
required

The id of the object the field values are being set on.

string
enum
required

The type of object the fields are associated with.

Allowed:
values
array of objects
required
length ≥ 1

Array of custom field updates to apply

values*
uuid
required

The unique id of the Custom Field definition for the field

required

The value to store in the field

Response

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json