Skip to main content
POST
/
v1
/
records
/
delete
Delete records
curl --request POST \
  --url https://api.withsplendor.com/v1/records/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "dataset_id": "<string>",
  "record_ids": [
    "<string>"
  ],
  "reason": "<string>"
}
'
{
  "completed_at": "2026-01-15T09:30:00Z",
  "created_at": "2026-01-15T09:30:00Z",
  "error_message": null,
  "item_failed_count": 0,
  "item_pending_count": 0,
  "item_running_count": 0,
  "item_succeeded_count": 1,
  "item_total_count": 1,
  "items": [
    {
      "attempt_count": 1,
      "completed_at": "2026-01-15T09:30:00Z",
      "created_at": "2026-01-15T09:30:00Z",
      "error_message": null,
      "item_id": 1,
      "item_type": "object_document",
      "next_attempt_at": null,
      "result": {
        "deleted_documents": 1240000
      },
      "started_at": "2026-01-15T09:30:00Z",
      "status": "succeeded",
      "target": {
        "dataset_id": "app-logs"
      },
      "updated_at": "2026-01-15T09:30:00Z"
    }
  ],
  "job_id": "ddl_01H8Z3",
  "requested_by": "user_01H8Z3",
  "scope": "dataset",
  "started_at": "2026-01-15T09:30:00Z",
  "status": "succeeded",
  "target_dataset_id": "app-logs",
  "target_source_id": null,
  "target_upload_session_id": null,
  "tenant_id": "acme",
  "updated_at": "2026-01-15T09:30:00Z"
}

Authorizations

​
Authorization
string
header
required

API token issued from the Splendor console.

Headers

​
x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json

Delete a specific set of records (by record_id) from a dataset.

Capped at 1024 record_ids per request: the deletion worker issues one delete-by-query for the whole set (it does not chunk), so an unbounded set would produce an oversized query. Send larger deletes in batches.

​
dataset_id
string
required
Required string length: 1 - 128
​
record_ids
string[]
required
Required array length: 1 - 1024 elements
Required string length: 1 - 512
​
reason
string | null
Maximum string length: 1024

Response

Successful Response

​
completed_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
error_message
string | null
required
​
item_failed_count
integer
required
​
item_pending_count
integer
required
​
item_running_count
integer
required
​
item_succeeded_count
integer
required
​
item_total_count
integer
required
​
items
DataDeletionJobItemResponse · object[]
required
​
job_id
string
required
​
requested_by
string | null
required
​
scope
enum<string>
required
Available options:
hosted_upload,
source,
dataset,
object,
record,
tenant
​
started_at
string<date-time> | null
required
​
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
​
target_dataset_id
string | null
required
​
target_source_id
integer | null
required
​
target_upload_session_id
string | null
required
​
tenant_id
string
required
​
updated_at
string<date-time>
required