Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Custom Field

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.

Note: To set custom fields on an Employee, use user.setCustomFieldValue instead.

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
  • LongText, 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
  • Currency - An object with the following properties:
    • value: A number
    • currencyCode: A valid ISO 4217 currency code
  • 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)

Requires the candidatesWrite permission.

post/customField.setValue

Request body

objectIdstring uuid required

The id of the object the field value is being set on.

objectType'Application' | 'Candidate' | 'Job' | 'Opening' required

The type of object the field is associated with.

fieldIdstring uuid required

The unique id of the Custom Field definition for the field

Example request

{
  "objectId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "fieldId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the customField.setValue endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
    "title": "Preferred Team",
    "isPrivate": false,
    "value": "Backend"
  }
}