Documents

Update Library Document

Edit a document: rename it, replace its text, or move it.

PARTIAL despite the PUT verb - an omitted field is left alone, which is the app's own shape. meta_data REPLACES the stored object rather than merging into it.

put/library/documents/{document_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/library/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring required

Document id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

display_namestring nullable
contentstring nullable

Replaces the whole document body when given.

folder_pathstring nullable

Moves the document to another folder when given.

meta_dataobject nullable

Free-form metadata. REPLACES the stored object rather than merging.

Response

Successful Response

dataDocumentPayload required

An open envelope for one document, folder or questionnaire.

Open on purpose: a Library document carries extraction metadata, a questionnaire carries per-provider processing detail, and a generated deal document carries structured_data and highlights whose shape is the generator's rather than this contract's. Pinning those would silently drop whatever the app learned to return that this file had not caught up on.

Changes

No recorded changes to this operation across all 2 revisions of this API.