GEgem
Custom Field Options

Modify an option in a custom field

Returns an option in a single_select or multi_select custom field.

Custom Field Option cannot be deleted and can only be hidden.

patch/v0/custom_fields/{custom_field_id}/options/{option_id}

Request

  • Base URL
    https://api.gem.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.gem.com/v0/custom_fields/{custom_field_id}/options/{option_id}
  • Auth
    none declared

Request body

is_hiddenboolean

hidden options are not selectable in the Gem product. Candidate custom field values with hidden options are not returned when making a query to the Candidates endpoint.

Response

OK

idstring ObjectID
valuestring
is_hiddenboolean

hidden options are not selectable in the Gem product. Candidate custom field values with hidden options are not returned when making a query to the Candidates endpoint.

Changes

No recorded changes to this operation across all 1 revision of this API.