Deals

Update Deal Document

Edit a generated document by hand.

Keyed by document ID, not by type - this is the one place the two identifier spaces differ, and it is why the type-keyed routes live under /documents/types/.

An omitted field is left alone; structured_data REPLACES the stored object rather than merging into it. A later regeneration OVERWRITES the edit, so edit last.

put/deals/{deal_id}/documents/{document_id}

Request

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

Path parameters

deal_idstring required

Deal id (UUID).

document_idstring required

Document id, from the list read.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

contentstring nullable

The document body.

structured_dataobject nullable

The machine-readable half. Replaces, does not merge.

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.