Skip to navigation
Workspace APIData Objects

Update a data-object definition

View as Markdown

Applies a field-by-key diff to a definition. Authorization: organization administrators only — other callers get 403. Body is strict (immutable name/field keys rejected). Fields present are upserted; omitting an active field soft-archives it (archive-on-omit). Changing a field type while live objects exist returns 409 type_change_blocked (with fieldKey); the version bumps only on a schema-affecting change. Unknown id → 404, invalid body → 422 validation_failed. Returns { definition }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

definitionIdstringRequired

Request

Strict: nameSingular and unknown keys are rejected. Fields present are upserted; omitting an active field soft-archives it.

labelSingularstringOptional1-200 characters
labelPluralstringOptional1-200 characters
namePluralstringOptional1-64 characters
descriptionstringOptional<=2000 characters
iconstringOptional1-64 characters
colorstring or nullOptional
labelFieldKeystringOptional>=1 character
fieldslist of maps from strings to anyOptional

Field descriptors. Each names a key, a type and its type-specific options.

fieldGroupslist of maps from strings to anyOptional

Response

The updated definition.
definitionobject

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error