v1

latestOpenAPI 3.1.0Serval License2026-07-26202952779.1 KB
Entity Type API

Update Entity Type Field

Update an entity type field: rename it (set name) and/or change its data type (set data_type, plus enum_options when the new type is ENUM/MULTI_SELECT). At most one attribute may change per request. This is an asynchronous schema migration: the response contains schema_migration_id, which you poll via Get Schema Migration to track completion.

put/v2/entity-type-fields/{id}

Path parameters

idstring required

The ID of the entity type field to update.

Request body

namestring nullable

New display name. When provided and different from the current name, the field is renamed (key re-derived via slugify). Omit to leave unchanged.

dataType'DATA_TYPE_UNSPECIFIED' | 'TEXT' | 'NUMBER' | 'BOOL' | 'TIMESTAMP' | 'ENUM' | 'ENTITY_REF' | 'USER_REF' | 'UNIQUE' | 'MULTI_SELECT' | 'FILE'

Response

Success