v1

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

Delete Entity Type Field

Delete an entity type field. By default the field is also removed from descendant types that inherit it; set keep_on_children=true to detach instead. This is an asynchronous schema migration: the response contains schema_migration_id, which you poll via Get Schema Migration to track completion.

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

Path parameters

idstring required

The ID of the entity type field to delete.

Query parameters

keepOnChildrenboolean

When false (default), the field is also removed from all descendant entity types that inherit it (cascade delete). When true, the field is removed only from this entity type; direct children that inherited it are promoted to "own" it, and deeper descendants continue to inherit from those children.

When false (default), the field is also removed from all descendant entity types that inherit it (cascade delete). When true, the field is removed only from this entity type; direct children that inherited it are promoted to "own" it, and deeper descendants continue to inherit from those children.

Response

Success