Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Custom Field

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.

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

The values accepted in the fieldValue param depend on the type of field that's being updated. See the customField.setValue docs for the full per-type table.

Requires the candidatesWrite permission.

post/customField.setValues

Request body

objectIdstring uuid required

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

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

The type of object the fields are associated with.

Example request

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

Response

Responses from the customField.setValues endpoint

OR

Example response

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