SnozeDevelopers
API referenceDatabases

Move a database group to trash

Archives up to 2,000 specified records and hides their group in the selected view in one transaction. A permission, validation, or missing-record failure rolls back the entire change. Requires records:write and views:write permissions; archived records remain recoverable.

POST
/v1/workspaces/{workspaceId}/databases/{databaseId}/trash-group
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string
databaseId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/databases/string/trash-group" \  -H "Content-Type: application/json" \  -d '{    "recordIds": [],    "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73",    "groupKey": "string"  }'
{  "data": {    "id": "string",    "workspaceId": "string",    "databaseId": "string",    "key": "string",    "label": "string",    "kind": "table",    "placement": "database",    "manifest": {},    "relationFieldId": "string",    "ownerUserId": "string",    "scope": "shared",    "locked": true,    "definitionVersion": 0,    "createdAt": "string",    "updatedAt": "string"  }}