Update document metadata

Update native document metadata and review state.

Outcome

Update native document metadata and review state.

These examples were captured from the local Worker. Deployment, publication and retrieval are verified separately for each environment; local examples do not establish external provider delivery.

Before you start

Inspect the credential identity with topolo whoami and the exact action with topolo actions get before preparing input.
Discover an accessible Docs workspace with topolo resources topolo-docs and topolo workspaces list topolo-docs. Pass workspace resource type and identifier separately from action input.
The published required permission is docs:write; the active credential and resource binding must authorize the call.
Validate and plan the exact request. Execute only after the intended effect has been authorized; --confirm is the transport guard, not a grant of permission.

Discover the target


topolo actions get app_topolo_docs.documents.update --detail --json
topolo resources topolo-docs --json
topolo workspaces list topolo-docs --json
Discover documentId with app_topolo_docs.documents.list.

Input fields

Field	Required	Meaning
`documentId`	Yes	Stable document identifier discovered from documents.list, spaces.documents.list or owned_documents.list in the active credential context.
`parentId`	No	Parent document identifier for hierarchy, or null to remove the parent. Discover the parent in the same workspace; omission preserves the parent when updating metadata. Owned-document upsert requires the same owner and audience, and refuses missing parents, self-parenting and cycles.
`title`	No	Human-readable title. Native creation uses an Untitled space, Untitled document or Untitled section title when omitted. Updates preserve an omitted title; document versions snapshot their title.
`slug`	No	URL or navigation slug. Creation normalizes the supplied value or derives it from title and resolves collisions. Updates preserve it when omitted; changing a public space or document slug changes its address.
`summary`	No	Short document summary, stored up to 2,000 characters. A new version snapshots it; public reads retain the explicitly published version summary.
`status`	No	Native document review state, draft or review. Public publication is controlled by documents.publish and documents.unpublish rather than this metadata field.

Interpret the response

document contains the updated metadata and review state. This action does not create a new body version or publish it. Public readers retain the published version title and summary.

Worked examples

The following inputs and responses were captured from the local Docs worker fixture. Auth and Nexus dependencies are simulated. Identifiers, URLs and timestamps are illustrative fixture values. Discover your own identifiers and choose an appropriate test resource; copying a fixture identifier does not make it valid in your environment. For workspace-bound calls, set DOCS_WORKSPACE_ID to the identifier returned by resource discovery. Run validation and planning first; the final call requires the intended effect to be authorized.

Minimal example

Save the input as payload.json:


{
  "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4",
  "summary": "Safely replace an integration token.",
  "status": "review"
}

CLI:


topolo actions validate app_topolo_docs.documents.update --data @payload.json --json
topolo actions plan app_topolo_docs.documents.update --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.documents.update --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:


{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_docs.documents.update",
    "input": {
      "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4",
      "summary": "Safely replace an integration token.",
      "status": "review"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:


{
  "document": {
    "id": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4",
    "organizationId": "org_fixture",
    "workspaceId": "ws_fixture",
    "spaceId": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
    "sectionId": "docsec_9c57d921-baf8-455c-89a0-5abb407cb339",
    "sectionPosition": 0,
    "parentId": null,
    "slug": "rotate-token",
    "title": "Rotate an integration token",
    "summary": "Safely replace an integration token.",
    "status": "review",
    "sourceKind": "native",
    "ownerAppId": null,
    "currentVersionId": "docver_cef00930-d087-4485-98bc-0f335d96fd80",
    "publishedVersionId": null,
    "createdByUserId": "usr_fixture",
    "createdAt": "2026-10-03T08:07:30.565Z",
    "updatedAt": "2026-10-03T08:07:30.846Z",
    "publishedAt": null
  }
}

document contains the updated metadata and review state. This action does not create a new body version or publish it. Public readers retain the published version title and summary.

Workflow example

Save the input as payload.json:


{
  "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38",
  "summary": "Safely replace an integration token.",
  "status": "review"
}

CLI:


topolo actions validate app_topolo_docs.documents.update --data @payload.json --json
topolo actions plan app_topolo_docs.documents.update --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.documents.update --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:


{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_docs.documents.update",
    "input": {
      "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38",
      "summary": "Safely replace an integration token.",
      "status": "review"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:


{
  "document": {
    "id": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38",
    "organizationId": "org_fixture",
    "workspaceId": "ws_fixture",
    "spaceId": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
    "sectionId": "docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4",
    "sectionPosition": 0,
    "parentId": null,
    "slug": "rotate-token",
    "title": "Rotate an integration token",
    "summary": "Safely replace an integration token.",
    "status": "review",
    "sourceKind": "native",
    "ownerAppId": null,
    "currentVersionId": "docver_de2b1e18-55d5-4793-b71f-51bc27b78c84",
    "publishedVersionId": null,
    "createdByUserId": "usr_fixture",
    "createdAt": "2026-10-03T08:07:34.003Z",
    "updatedAt": "2026-10-03T08:07:34.237Z",
    "publishedAt": null
  }
}

document contains the updated metadata and review state. This action does not create a new body version or publish it. Public readers retain the published version title and summary.

Verify the result

Call documents.get and confirm the metadata reads as sent and the current version is unchanged.

Errors and recovery

HTTP 403 · organization_required: The token carries no organization scope. Re-authenticate against the organization that owns the Docs workspace and retry.
HTTP 400 · workspace_required: No Docs workspace resolved for the caller. Call workspace.get to see which workspace is bound, then retry in that context.
HTTP 403 · permission_denied: The credential needs docs:write on the selected Docs workspace.
HTTP 400 · invalid_json_object: The body was missing, malformed, or carried a key the action does not accept. Send a JSON object matching inputSchema exactly — these routes reject unknown keys.
HTTP 404 · not_found: No record in this workspace carries that id. List the resource first and use an id from the response.

Call this action again with the previous metadata. The body cannot be damaged here — versions are immutable.

Evidence boundary

These examples establish local handler behavior and schema validity. They do not establish runtime permission parity, a deployed development/staging result or production completion. Preserve the actual request identifier and perform the verification reads after an authorized live call.