Documents

Update many documents

POST/documents/bulk/update
documents:writebulk_update_documentsIdempotent

Changes up to 100 documents in the request, or 101 to 10,000 as a job that answers 202 with the job. Each item is a document id with the fields to change, as in PATCH /documents/{id}, moves included, and runs on its own: a failed item is reported in its slot and the rest carry on. Use PATCH /documents/{id} for one document. dry_run runs up to 100 items and rolls them back. Emits document.updated per item that succeeds, after commit, and sends no email. Sending the previous values undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DocumentBulkUpdate

  • itemsobject[]Required#

    Up to 10,000 items. Each is a document id plus the fields to change, as in DocumentUpdate. Up to 100 run in the request.

{
  "items": [
    {
      "id": "5e6f7081-92a3-4b4c-9d6e-7f8091a2b3c4",
      "name": "term-sheet-final.pdf"
    },
    {
      "id": "6f708192-a3b4-4c5d-8e6f-7081a2b3c4d5",
      "folder_id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f"
    }
  ]
}

Responses

200

Every item in request order, each succeeded or failed.

DocumentBulkReport
{
  "data": [
    {
      "index": 1,
      "status": "succeeded",
      "data": {},
      "error": {}
    }
  ],
  "meta": {
    "succeeded": 1,
    "failed": 1
  }
}
202

More than 100 items. A job runs them; its report has the same shape as the 200 body.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/documents/bulk/update\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    {
      "id": "5e6f7081-92a3-4b4c-9d6e-7f8091a2b3c4",
      "name": "term-sheet-final.pdf"
    },
    {
      "id": "6f708192-a3b4-4c5d-8e6f-7081a2b3c4d5",
      "folder_id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f"
    }
  ]
}'