Skip to main content
DELETE
Delete entity schema

Authorizations

api_key
string
header
required

Personal API key.

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