---
title: "Edit Custom Field List Value"
method: PATCH
path: "/api/v1/hris/custom-fields/{customFieldId}/list-values/{listValueId}"
tags: ["Custom Fields", "Public API"]
---

# Edit Custom Field List Value

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

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/hris/custom-fields/{customFieldId}/list-values/{listValueId}`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `employee:custom_fields.write`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/hris/custom-fields/:customFieldId/list-values/:listValueId/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

OAuth Scopes: employee:custom_fields.write

## Path parameters

- `customFieldId` string, required
- `listValueId` string, required

## Request body

- ChangeCustomFieldListValueRequest
  - `option` string: The new list value
  - `preserveExistingOption` boolean: Whether to preserve the existing option or not

## Response `200`

List value edited.

- object
  - `id` string: The string list value ID.
  - `legacyId` integer: The legacy numeric list value ID.
  - `display` string: List value display name.

## Other responses

- `400`: Invalid argument.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `415`: Unsupported media type. Content-Type must be application/merge-patch+json.
- `422`: Validation failed.
- `500`: Internal server error.

## Changes

- **2026-11-03** `922fc15f43a7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bamboohr/apis/bamboohr-api/changes/api/v1/hris/custom-fields/:customFieldId/list-values/:listValueId/patch.md)

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)