Deals

Delete Deal Document

Remove a generated document.

Not destructive in the way a deleted record is: the document can be generated again from the same sources - at the cost of the credits that takes.

delete/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

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.