Skip to main content
DELETE
Delete Entity Type Field

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the entity type field to delete.

Query Parameters

keepOnChildren
boolean

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

200 - application/json

Success

data
data · object

Reference to the staged delete migration.