Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.setCustomFieldValue

Set the value of a custom field on an employee.

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

Note: When updating multiple custom fields on the same employee, use user.setCustomFieldValues instead to avoid race conditions.

Requires the organizationWrite permission.

post/user.setCustomFieldValue

Request body

userIdstring uuid required

The id of the employee to set the custom field value for

fieldIdstring uuid required

The unique id of the Custom Field definition for the field

Example request

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

Response

Responses from the user.setCustomFieldValue endpoint

OR

Example response

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