---
title: "customField.updateSelectableValues"
method: POST
path: "/customField.updateSelectableValues"
tags: ["Custom Field"]
---

# customField.updateSelectableValues

`POST /customField.updateSelectableValues`

Update the selectable values for a custom field.

This endpoint merges the provided selectable values with the existing values for a custom field.

**Merge behavior:**
- **New values** (values not present in the existing values) are added to the field
- **Existing values** (matching by `value` field) have their `label` updated and `isArchived` status set from the request
- **Omitted values** (existing values not included in the request) are marked as archived
- Metadata such as substitution tokens are preserved for existing values

The `isArchived` field defaults to `false` if not provided.

**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldupdateselectablevalues) permission.**

## Request body

- CustomFieldUpdateSelectableValuesRequest
  - `customFieldId` string, uuid, required — The id of the custom field to update
  - `selectableValues` object[], required — An array of selectable values to merge with the existing values. Only `label`, `value`, and optionally `isArchived` should be provided.
    - `label` string, required — The display label for this selectable value
    - `value` string, required — The internal value for this selectable value (used as the unique identifier)
    - `isArchived` boolean, nullable — Whether this value should be archived. Defaults to false if not provided.

## Response `200`

Responses from the customField.updateSelectableValues endpoint

- union
  - CustomFieldUpdateSelectableValuesSuccessResponse
    - `success` true, required
    - `results` CustomFieldDefinition, required
      - `id` string, required — The custom field's unique identifier
      - `title` string, required — The custom field's title
      - `description` string, nullable, required — A description of the custom field
      - `objectType` string, required — The type of object the field is associated with
      - `isArchived` boolean, required — Whether the custom field is archived
      - `isPrivate` boolean, required — Whether the custom field is private
      - `fieldType` string, required — The custom field's field type
      - `isRequired` boolean, required — Whether the custom field is required
      - `selectableValues` CustomFieldSelectableValue[] — Selectable values for ValueSelect and MultiValueSelect custom fields
        - `label` string, required — The display label for the selectable value
        - `value` string, required — The API value for the selectable value
        - `isArchived` boolean, required — Whether the selectable value is archived
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)