Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.setCustomFieldValues

Set the values of multiple custom fields on an employee in a single call. This is the recommended approach when updating multiple fields on the same employee to avoid race conditions that can occur with concurrent user.setCustomFieldValue calls.

The values accepted in the fieldValue param depend on the type of field being updated. See the customField.setValue docs for accepted types.

Requires the organizationWrite permission.

post/user.setCustomFieldValues

Request body

userIdstring uuid required

The id of the employee to set custom field values for

Example request

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

Response

Responses from the user.setCustomFieldValues endpoint

OR

Example response

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