Custom fields

Update a dataobject custom field

Partial update of a definition. Only definitions targeting data objects are reachable here — any other identifier returns a 404.

Required scope tenant:edit

patch/data/custom-fields/{id}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the definition.

Bodyapplication/json

namestring

Label of the field.

descriptionstring

Help text shown next to the field.

iconstring

Icon of the field.

optionsobject[]

Options offered.

Response200 · application/json

The updated definition.

idstring<uuid>required

Identifier of the definition.

namestringrequired

Label of the field.

typeenum<string>required

Type of the field, which determines the shape of its values.

Available options: text, select, multi_select, date

descriptionstring | null

Help text shown next to the field.

optionsobject[]

Available options, for `select` and `multi_select` fields.