Custom fields

Create a dataobject custom field

Define a new custom field for data objects. `options` is required for `select` and `multi_select` fields, and ignored otherwise.

Required scope tenant:edit

post/data/custom-fields

Authorizations

Authorizationstringrequired

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

Bodyapplication/json

namestringrequired

Label of the field.

typeenum<string>required

Type of the field.

Available options: text, select, multi_select, date

descriptionstring

Help text shown next to the field.

iconstring

Icon of the field.

optionsobject[]

Options offered, for `select` and `multi_select` fields.

Response201 · application/json

The definition was created.

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.