Skip to main content
DELETE
Delete entity schema

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

entity_name
string
required

Name of the entity to remove, as returned by List entity schemas. Pass User to drop the built-in user entity's custom fields.

app_id
string
required

ID of the app whose entity schemas you want to work with.

Response

Successful Response

Confirmation that an entity was removed from the app.

success
boolean
required

Always true. A delete that failed returns an error status instead.

Example:

true