BAbamboohr
Custom Fields
Public API

Edit Custom Field List Value

Changed on

Updates a dropdown option on a list-type custom field.

OAuth Scopes: employee:custom_fields.write

patch/api/v1/hris/custom-fields/{customFieldId}/list-values/{listValueId}

Request

Path parameters

customFieldIdstring required
Example:123

The ID of the custom field.

listValueIdstring required
Example:456

The ID of the list value to edit.

Request body

optionstring

The new list value

preserveExistingOptionboolean

Whether to preserve the existing option or not

Response

List value edited.

idstring

The string list value ID.

legacyIdinteger

The legacy numeric list value ID.

displaystring

List value display name.

Changes