Delete Entity Records

Permanently deletes records of an entity, identified either by record ID or by the value of the entity's primary key column. Up to 1000 records per request.

For each record this also deletes its attached files and their tags, its comments, and its links to cases and documents (the documents themselves are kept). Links to a deleted record from other entities' linked-record columns are left in place.

Primary-key values are matched the way the entity enforces uniqueness: surrounding spaces are ignored, the value is read as the column's type, and text is compared case-insensitively.

Identifiers that match no record are returned in not_found instead of failing the request. A request that fails part way leaves its records in place, so it is always safe to retry. Repeated identifiers are processed once.

Available to owners and admins only. Deletion is permanent and cannot be undone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the entity. You can find it in the entity's URL in the Docsumo app: /tables/<entity_id>.

Body Params

Provide exactly one of record_ids or primary_key_values.

record_ids
array of strings
length between 1 and 1000

IDs of the records to delete. A record's ID is in its URL in the Docsumo app: /tables/<entity_id>/record/<record_id>.

record_ids
primary_key_values
array
length between 1 and 1000

Values of the entity's primary key column for the records to delete. The entity must have a primary key column.

primary_key_values
Headers
string
required

API key used for authentication. The key must belong to an owner or admin. You can find it on your Docsumo settings page.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json