Skip to main content
POST
Delete records

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