Delete Rows

Delete rows by a non-empty predicate or an explicit bounded list of row identifiers.

DELETE/api/v2/tables/{tableId}/rows

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

Path Parameters

tableId*string

Unique table identifier.

Length1 <= length

Request Body

application/json

Workspace scope and exactly one of a predicate or row identifier list.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceId*string

Unique workspace identifier.

Length1 <= length <= 128

filter?|

Recursive predicate tree. Each group node is exactly one non-empty all or any array whose members are further groups or { field, op, value } conditions; the root must be a group, not a bare condition. At most 100 members per group, 10 levels of nesting, and 500 nodes in total. The negating operators include nulls: ne, nin, ncontains, nlike, and nilike match rows whose column is null or absent, so "not X" is not the complement of "X" over a nullable column. That holds for every column type, multi-select included. To exclude nulls, all-combine the negation with isNotEmpty (multi-select) or isNotNull. Comparison: eq, ne, gt, gte, lt, lte. Membership: in, nin (array operand). Emptiness: isEmpty, isNotEmpty, isNull, isNotNull (no operand). Substring, always case-insensitive, operand matched literally: contains, ncontains, startsWith, endsWith. Pattern: like/nlike (case-sensitive), ilike/nilike (case-insensitive). * is the only wildcard and stands for any run of characters; %, _, and backslash match themselves. Use like: "Hi*", not like: "Hi%". A select column compares by option id and restricts its operators: single-select accepts eq, ne, in, nin; multi-select accepts contains, ncontains. Option names are accepted as operands and resolved to ids.

limit?integer

Maximum matching rows to delete.

Range1 <= value <= 1000

rowIds?array<>

Explicit row identifiers to delete.

Items1 <= items <= 1000

Response Body

`application/json`

curl -X DELETE "https://www.sim.ai/api/v2/tables/string/rows" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "rowIds": [      "row_1f3e5d7c9b8a4c2d806e4a6b8d0f2e93"    ]  }'

{
  "data": {
    "deletedCount": 0,
    "deletedRowIds": [
      "string"
    ],
    "requestedCount": 0,
    "missingRowIds": [
      "string"
    ]
  }
}

{
  "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": "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"
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

423application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`