v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Bucket Objects

Bulk Soft-Delete Objects

Soft-delete many objects by ID in one call (recoverable). Records are retained and flipped to a non-active lifecycle state (so retrieval excludes them), with the lifecycle propagated to downstream documents. Bucket stats are recomputed once. Designed for large purges (e.g. scoping a synced bucket to a subset) without the per-object webhook/stats storms of single delete.

post/v1/buckets/{bucket_identifier}/objects/bulk-soft-delete

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

Request body

object_idsstring[] required

Object IDs to soft-delete (max 5000 per request). Records are retained and flipped to a non-active lifecycle state so retrieval excludes them; reversible by clearing the marker.

reasonstring required

Why these objects are being soft-deleted (audit trail).

lifecycle_statestring

Lifecycle state to flip to (default 'disabled').

sourcestring

Marker source tag (default 'bulk_purge').

Example request

{
  "object_ids": [
    "obj_abc123",
    "obj_def456"
  ],
  "reason": "scope footage bucket to 8 target brands"
}

Response

Successful Response

soft_deletedinteger required

Number of object records flipped.

requestedinteger required

Number of object IDs requested.

collectionsinteger required

Collections sourced from the bucket considered for propagation.