Businessmap icon

Businessmap

Use Businessmap API v2

Actions48

Document → Update

AI-generated

Overview

This node operation updates an existing document in the Businessmap system. It allows users to modify the document's title, content, and various metadata fields such as whether the document is shown on the welcome screen, archived, marked as important, indexed for AI, or nested under a parent document. This operation is useful for maintaining and organizing documents dynamically within a workflow, such as updating content or changing document status based on external triggers.

Use Case Examples

  1. Updating a document's title and content after receiving new information.
  2. Marking a document as important or archived based on user input.
  3. Changing the parent document to reorganize document hierarchy.

Properties

Name Meaning
Document ID The unique identifier of the document to update. Required to specify which document to modify.
Title The new title for the document. Leaving this empty keeps the current title unchanged.
Content The new content for the document, which can be plain text or HTML. Leaving this empty keeps the current content unchanged.
Update Fields Additional optional fields to update various document attributes such as visibility on the welcome screen, archival status, importance, AI indexing, and parent document relationship.

Output

JSON

  • document
    • id - The unique identifier of the updated document.
    • title - The updated title of the document.
    • content - The updated content of the document.
    • for_welcome - Flag indicating if the document is shown on the welcome screen.
    • is_archived - Flag indicating if the document is archived.
    • is_important - Flag indicating if the document is marked as important.
    • is_indexed_for_ai - Flag indicating if the document is indexed for AI.
    • parent_doc_id - The ID of the parent document if nested, or 0 if top-level.

Dependencies

  • Requires API authentication to Businessmap service to perform document updates.

Troubleshooting

  • Ensure the Document ID is valid and exists; otherwise, the update will fail.
  • Check permissions for AI indexing if updating the 'Is Indexed for AI' field, as special permissions are required.
  • Empty title or content fields will keep the current values; ensure this is intended to avoid unintentional data retention.

Discussion