Update a document

Updates one or more fields on a document. Frozen documents return 409.

PATCH/api/v1/documents/:id

Authorization

documents:writeapi key scoperequired

Required scope when calling with an API key.

document:writesession capabilityoptional

Required capability when calling with a signed-in session.

Path parameters

idstringrequired

Document ID

Example: doc_abc123

Request body

titlestringoptional

New document title

Example request

{
  "title": "Updated title"
}

Request

PATCH /api/v1/documents/:id

curl -X PATCH "https://www.digitalstack360.com/api/v1/documents/doc_abc123" \
  -H "Authorization: Bearer $DS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Updated title"}'

Examples use a placeholder key from your environment. Store your key in $DS_API_KEY — never commit it.

Response

200 OK

{
  "data": {
    "document_id": "doc_abc123",
    "title": "Updated title",
    "document_type": "vsow",
    "workflow_state": "draft",
    "is_frozen": false,
    "updated_at": "2026-05-12T11:00:00.000Z"
  }
}

Errors

401

missing_auth

No credentials provided

401

invalid_api_key

API key is invalid or revoked

400

bad_request

Missing or invalid request fields

403

scope_insufficient

Key lacks the required write scope

404

not_found

Document not found

409

document_immutable

Document is frozen and cannot be modified