API Reference

Update custom field option

patch
https://harvest.greenhouse.io/v3/custom_field_options/

Edit the display label, sort order, or external id of an existing custom field option. The parent custom_field_id cannot be moved through this endpoint — options stay attached to the field they were created under. Archived options cannot be updated through this endpoint — requests for an archived id return 404; reactivate via the create endpoint instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
length ≤ 255

New display label for the option. Must be unique among active options on the same custom field.

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.

string
length ≤ 255

New caller-supplied identifier from the partner's source system. Send an empty string to clear a previously stored value.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Updated 4 months ago

Did this page help you?
Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?