Partially update a custom field definition
Patch one or more attributes of a custom field definition without resending
the full record. Only the keys you include are touched; omitted keys keep
their current value. To clear options, send "options": null.
Useful for renaming a label, adjusting options.helpText, or relinking
object_types without resubmitting the entire definition.
To add or remove dropdown choices on a dropdown field, prefer
PATCH /custom-fields/{customFieldId}/choices — it performs a safe
additive/subtractive update against the existing choice list.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
The unique identifier of the custom field definition
Body
Any subset of the writable custom field fields. All keys are optional; include only what you want to change.
New display label (must remain unique across definitions).
255"Industry Segment"
Data type of the custom field. Changing type may require also
sending options (e.g. switching to dropdown requires a
non-empty choices array).
number, date, string, dropdown "dropdown"
Replace the options blob. Send null to clear. For dropdown
fields, prefer the /choices PATCH endpoint to add/remove
individual choices without resending the whole list.
Replace the list of linked entity types. Pass an empty array to unlink from all entity types. Omit the key entirely to leave the current linkage untouched.
Response
Custom field definition successfully patched