Bulk Delete Tables and Folders

Archive up to 100 tables and delete table folders in a single authorized request. Folders are named by canonical path and each cascades to everything inside it; deletedItems reports the totals across every cascade. Archived tables stay recoverable through POST /api/v2/tables/{tableId}/restore. Best-effort per item, with the same skipped / notFound / failed dispositions as the bulk move.

POST/api/v2/tables/bulk-delete

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Request Body

application/json

Workspace scope, and the tables and folder paths to delete.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.sim.ai/api/v2/tables/bulk-delete" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string"  }'
{
  "data": {
    "deleted": [
      {
        "kind": "table",
        "id": "string",
        "name": "string"
      }
    ],
    "skipped": [
      {
        "kind": "table",
        "id": "string",
        "name": "string"
      }
    ],
    "notFound": [
      {
        "kind": "table",
        "id": "string"
      }
    ],
    "failed": [
      {
        "kind": "table",
        "id": "string",
        "name": "string",
        "reason": "string"
      }
    ],
    "deletedItems": {
      "tables": -9007199254740991,
      "folders": -9007199254740991
    }
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "LOCKED",
    "message": "This table is insert-locked: new rows cannot be added.",
    "details": {
      "lock": "insert"
    }
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}