Skip to main content
DELETE
Delete entity record

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

entity_id
string
required

ID of the record, as id in the response of List entity records.

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.

Response

The record was deleted.

Confirmation that a record was deleted.

success
boolean
required

Always true. A delete that doesn't happen returns an error instead.

Example:

true