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. To reactivate an archived option, PATCH it with the desired name (and the same custom_field_id it was archived from).

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; collisions with an archived option's name 422 — reactivate the archived option instead.

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 3 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 3 months ago

Did this page help you?