> ## Documentation index
> Fetch the complete documentation index at: https://dify-docs.docs7.io/llms.txt
> Ask it with GET https://dify-docs.docs7.io/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.

# Update Document Status in Batch

> Enables, disables, archives, or unarchives multiple documents in one request.

`PATCH /datasets/{dataset_id}/documents/status/{action}`

## OpenAPI

````yaml en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}
openapi: 3.0.1
info:
  description: REST API for Dify applications and knowledge bases. Application
    endpoints authenticate with an app API key; knowledge endpoints authenticate
    with a dataset API key.
  title: Dify Service API
  version: 1.0.0
servers:
  - description: Base URL of the Dify Service API. For self-hosted deployments,
      replace it with your own API base URL.
    url: https://{api_base_url}
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: Host and path of the API base URL, without the `https://` prefix.
security:
  - ApiKeyAuth: []
tags:
  - description: Operations related to chat messages and interactions.
    name: Chat Messages
  - description: File upload and preview operations.
    name: Files
  - description: Operations related to end user information.
    name: End Users
  - description: User feedback operations.
    name: Feedback
  - description: Operations related to managing conversations.
    name: Conversations
  - description: Text-to-Speech and Speech-to-Text operations.
    name: Audio
  - description: Operations to retrieve application settings and information.
    name: Applications
  - description: Operations related to managing annotations for direct replies.
    name: Annotations
  - description: Endpoints for resuming paused workflows that require human input.
    name: Human Input
  - description: Operations for executing and managing workflows.
    name: Workflow Runs
  - description: Operations related to text generation and completion.
    name: Completion Messages
  - description: Operations for managing knowledge bases, including creation,
      configuration, and retrieval.
    name: Knowledge Bases
  - description: Operations for creating, updating, and managing documents within a
      knowledge base.
    name: Documents
  - description: Operations for managing document chunks and child chunks.
    name: Chunks
  - description: Operations for managing knowledge base metadata fields and document
      metadata values.
    name: Metadata
  - description: Operations for managing knowledge base tags and tag bindings.
    name: Tags
  - description: Operations for retrieving available models.
    name: Models
  - description: Operations for managing and running knowledge pipelines, including
      datasource plugins and pipeline execution.
    name: Knowledge Pipeline
paths:
  /datasets/{dataset_id}/documents/status/{action}:
    patch:
      description: Enables, disables, archives, or unarchives multiple documents in
        one request.
      operationId: batchUpdateDocumentStatus
      parameters:
        - description: Knowledge base ID, from [List Knowledge
            Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). For
            a scoped key, [copy the ID from the Dify
            URL](/en/api-reference/guides/knowledge#knowledge-base-id).
          in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
        - description: "`enable` activates documents for retrieval, `disable` deactivates
            them, `archive` moves them to the archive, `un_archive` restores
            them from the archive."
          in: path
          name: action
          required: true
          schema:
            enum:
              - enable
              - disable
              - archive
              - un_archive
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                document_ids:
                  description: Document IDs to update. Get them from [List
                    Documents](/en/api-reference/documents/list-documents).
                  items:
                    type: string
                  type: array
              required:
                - document_ids
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  summary: Response Example
                  value:
                    result: success
              schema:
                properties:
                  result:
                    description: Operation result.
                    type: string
                type: object
          description: Documents updated successfully.
        "400":
          content:
            application/json:
              examples:
                invalid_action:
                  summary: invalid_action
                  value:
                    code: invalid_action
                    message: Invalid action.
                    status: 400
          description: "`invalid_action` : Invalid action, or a document is in a state
            that does not allow the action (e.g. still indexing, or not
            completed)."
        "403":
          content:
            application/json:
              examples:
                forbidden_1:
                  summary: forbidden (api access)
                  value:
                    code: forbidden
                    message: Dataset api access is not enabled.
                    status: 403
                forbidden_2:
                  summary: forbidden (key scope)
                  value:
                    code: forbidden
                    message: The API key is not authorized to access this knowledge base.
                    status: 403
          description: >-
            - `forbidden` : Knowledge base API access is not enabled.

            - `forbidden` : The API key is scoped to specific knowledge bases,
            and this knowledge base is not one of them.
        "404":
          content:
            application/json:
              examples:
                not_found:
                  summary: not_found
                  value:
                    code: not_found
                    message: Dataset not found.
                    status: 404
          description: "`not_found` : Knowledge base not found."
      summary: Update Document Status in Batch
      tags:
        - Documents
      x-mint:
        href: /en/api-reference/documents/update-document-status-in-batch
        metadata:
          sidebarTitle: Update Document Status in Batch
          title: Update Document Status in Batch
components:
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: API_KEY
      description: >-
        Every request authenticates with an API key: `Authorization: Bearer
        {API_KEY}`. App endpoints take an app API key; knowledge endpoints take
        a knowledge base API key ([Get
        Started](/en/api-reference/guides/get-started)).


        Keep keys server-side; never embed them in client code. Requests with a
        missing or invalid key fail with HTTP `401` (`unauthorized`).
      scheme: bearer
      type: http
````