> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml post /v1/buckets/{bucket_identifier}/objects/bulk-soft-delete
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/buckets/{bucket_identifier}/objects/bulk-soft-delete:
    post:
      tags:
        - Bucket Objects
      summary: Bulk Soft-Delete Objects
      description: |-
        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.
      operationId: >-
        bulk_soft_delete_objects_v1_buckets__bucket_identifier__objects_bulk_soft_delete_post
      parameters:
        - name: bucket_identifier
          in: path
          required: true
          schema:
            type: string
            description: The unique identifier of the bucket.
            title: Bucket Identifier
          description: The unique identifier of the bucket.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkSoftDeleteRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSoftDeleteResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
          NamespaceHeader: []
components:
  schemas:
    BulkSoftDeleteRequest:
      properties:
        object_ids:
          items:
            type: string
          type: array
          maxItems: 5000
          minItems: 1
          title: Object Ids
          description: >-
            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.
        reason:
          type: string
          maxLength: 500
          title: Reason
          description: Why these objects are being soft-deleted (audit trail).
        lifecycle_state:
          type: string
          title: Lifecycle State
          description: Lifecycle state to flip to (default 'disabled').
          default: disabled
        source:
          type: string
          title: Source
          description: Marker source tag (default 'bulk_purge').
          default: bulk_purge
      type: object
      required:
        - object_ids
        - reason
      title: BulkSoftDeleteRequest
      description: Request model for bulk soft-deleting objects by id (recoverable purge).
      examples:
        - object_ids:
            - obj_abc123
            - obj_def456
          reason: scope footage bucket to 8 target brands
    BulkSoftDeleteResponse:
      properties:
        soft_deleted:
          type: integer
          title: Soft Deleted
          description: Number of object records flipped.
        requested:
          type: integer
          title: Requested
          description: Number of object IDs requested.
        collections:
          type: integer
          title: Collections
          description: Collections sourced from the bucket considered for propagation.
      type: object
      required:
        - soft_deleted
        - requested
        - collections
      title: BulkSoftDeleteResponse
      description: Response for a bulk soft-delete operation.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing header returns
        403; an invalid or revoked key returns 401.
    NamespaceHeader:
      type: apiKey
      in: header
      name: X-Namespace
      description: >-
        Namespace id (`ns_...`), not the namespace name. This scopes the request
        rather than authenticating it, and it is required on every operation
        marked `x-mixpeek-namespace-scoped`.

````