deleteTableRows

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

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

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/tables/{table}/rows/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "ids": [
    123
  ],
  "filter": {},
  "deleteAllRows": true
}
'

200

{
  "deletedRows": 123
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-integration-name · string

Integration name

x-user-id · string

User Id

x-user-role · string

User Role

Path Parameters

table · string · required

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

Body

application/json

Identifiers of the rows to be deleted.

ids · number[]

Maximum array length: 1000

Required range: x <= 2147483647

filter · object

Filter to apply when deleting rows. Example: { "name": { "$eq": "John" } }

deleteAllRows · boolean

Flag to delete all rows. Use with caution as this action is irreversible.

Response

200

application/json

Confirms the number of rows successfully deleted.

deletedRows · number · required