Data

Set a custom field value

Set the value of one workspace custom field on the data object. The value is checked against the type of the field definition.

Required scope data:edit

put/data/{id}/custom-fields/{fieldId}

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 data object.

fieldIdstring<uuid>required

Identifier of the custom field definition.

Bodyapplication/json

valueany

The value to set, shaped by the field type, or `null` to clear it.

Response200 · application/json

The updated custom field value.

idstring<uuid>required

Identifier of the custom field definition.

namestringrequired

Label of the custom field.

typeenum<string>required

Type of the custom field, which determines the shape of `value`.

Available options: text, select, multi_select, date

descriptionstring | null

Help text attached to the custom field definition.

valueany

Value held by this application. A string for `text`, an ISO-8601 datetime for `date`, an `{id, value}` option for `select`, an array of options for `multi_select`, or `null` when unset.