Create custom field option

post

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

Add a new selectable value to a single_select or multi_select custom field. The parent field is identified by custom_field_id in the request body. If an archived option with the same name already exists on the field, this call returns 422 — reactivate that option with a PATCH (active: true) instead of creating a duplicate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 255

Display label for the option. Must be unique among active options on the same custom field; if a previously deleted option already has this name, reuse it via PATCH rather than POST (the create call will 422).

sort_order

integer

required

Display position within the dropdown. Lower values render first. Greenhouse does not normalize gaps, so partners managing reorderings typically space values (e.g. 10, 20, 30) to leave room for inserts.

custom_field_id

integer

required

Id of the parent custom field. Must be a single_select or multi_select field in the caller's organization.

external_id

string

length ≤ 255

Optional caller-supplied identifier from the partner's source system (e.g. an HRIS row id). Stored verbatim and returned on subsequent reads as external_id.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful