Update custom field

Edit the definition of an existing custom field. field_type and value_type are immutable — to change either, create a new field. As with create, the accepted properties vary by the field's existing field_type: job and opening fields expose approval and visibility toggles, offer fields expose trigger_new_version, user attributes are limited to name, description, and required. Manage option lists for select-type fields through /v3/custom_field_options, not this endpoint.

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 field. Renaming does not change name_key — integrations keyed off name_key continue working.

string

New helper text shown beneath the field label in the UI.

boolean

If true, only users granted the matching View Private permission can see this field's values.

string
length ≤ 255

Updated merge token usable in offer letter templates.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

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