Docs

deleteTableRows

Allows selective deletion of rows or complete clearance of a table.

POST/v1/tables/{table}/rows/delete

Authorization

AuthorizationBearerrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias
x-integration-namestring
Integration name
x-user-idstring
User Id
x-user-rolestring
User Role

Path parameters

tablestringrequired
The table's name or unique identifier for targeting specific table operations.

Request body

Identifiers of the rows to be deleted.

idsnumber[]
filterobject
Filter to apply when deleting rows. Deletion with a filter is performed asynchronously in batches and returns a job object to track progress. Example: \{ "createdAt": \{ "$lt": "2026-01-01" \} \}
deleteAllRowsboolean
Flag to delete all rows. Use with caution as this action is irreversible.

Response

Confirms the number of rows successfully deleted. When using a filter, returns a job object for tracking async progress.

deletedRowsnumberrequired
jobobject