---
title: "Bulk update custom field options"
method: PATCH
path: "/v3/custom_field_options/bulk"
tags: ["Custom Field Options"]
---

# Bulk update custom field options

`PATCH /v3/custom_field_options/bulk`

## Request

- Base URL: `https://harvest.greenhouse.io`
- URL: `https://harvest.greenhouse.io/v3/custom_field_options/bulk`
- Auth: OAuth 2
  - Authorization code: `https://auth.greenhouse.io/authorize`
  - Client credentials
  - Token URL: `https://auth.greenhouse.io/token` scopes: `harvest:custom_field_options:update`

Asynchronously edit the label, sort order, or external id of many options in one call — most often used to reorder a dropdown after an upstream HRIS reshuffle or to rename options en masse. Each item must include `id`; the remaining fields are treated as a partial update. Per-item success or failure is reported through the bulk-status endpoint.

## Request body

- object
  - `callback_url` string: Optional HTTPS URL Greenhouse will POST to when every row in `data` has finished. Omit to poll `GET /v3/bulk_requests/{bulk_action_uuid}` instead.
  - `data` object[], required: Array of single-resource update payloads to process. Each item must include the integer `id` of the record to update and otherwise match the schema of the matching non-bulk PATCH endpoint; rows are validated and executed independently.
    - `name` string: New display label for the option. Must be unique among active options on the same custom field.
    - `sort_order` integer: New display position within the dropdown. Lower values render first. Partners reorganizing dropdowns typically PATCH `sort_order` on every affected option in a single bulk update.
    - `external_id` string: New caller-supplied identifier from the partner's source system. Send an empty string to clear a previously stored value.
    - `id` integer, required

## Response `202`

Accepted

- object
  - `bulk_action_uuid` string: UUID assigned to the new bulk request. Use this with `GET /v3/bulk_requests/{bulk_action_uuid}` to monitor progress and retrieve per-row results.
  - `status` string: Initial lifecycle state of the new bulk request, typically `building` immediately after creation. See the bulk request response schema for the full set of values.
  - `status_url` string: Relative path that returns the current status of the bulk request. Append this to your Harvest base URL to fetch the latest state.

## Other responses

- `401`: Unauthorized
- `413`: Payload is larger than 10MB
- `422`: Validation Error
- `429`: Client has more than 5 active jobs

---

[API](https://skmtc.dev/greenhouse/apis/harvest-api.md) - [All operations](https://skmtc.dev/greenhouse/apis/harvest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/greenhouse/apis/harvest-api/revisions/822822e3f771?raw)