Sign in

Delete entity records

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Deletes every record in one of the app's entities that matches a filter, and returns how many it deleted.

Send the filter as the body, written the same way as the q parameter of List entity records. For example, {"status": "cancelled"} deletes every cancelled record. The body is required, and an empty object, {}, deletes every record in the entity.

Row-level security applies, so only the matching records the entity's rls delete rule lets you remove are deleted. The rest are left alone rather than failing the call.

The records move to the entity's trash rather than being erased. Bring them back with Restore entity records, or erase one for good with Permanently delete entity record.

Unlike Delete entity record, this doesn't trigger the app's webhooks, automations, or workflows.

<Note>This endpoint accepts a personal API key belonging to a user with access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

delete/api/apps/{app_id}/entities/{entity_name}

Path parameters

app_idstring required

ID of the app that owns the entity.

ID of the app that owns the entity.

entity_namestring 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.

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.

Request body

object required

Filter selecting the records to delete, in the same form as q. Send {} to delete every record in the entity.

Response

How many records were deleted.

successboolean required

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

deletedinteger required

Number of records moved to the trash. 0 when no record matched the filter.

Example response

{
  "success": true,
  "deleted": 3
}

Changes

Changed in 1 of the 33 revisions of this API.1