---
title: "Update Deal Document"
method: PUT
path: "/deals/{deal_id}/documents/{document_id}"
tags: ["Deals"]
---

# Update Deal Document

`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

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.

## Path parameters

- `deal_id` string, required: Deal id (UUID).
- `document_id` string, required: Document id, from the list read.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- DealDocumentUpdateRequest: Edit a generated deal document in place. Mirrors `campaign_builder.models.deal_documents.UpdateDealDocumentRequest`. An omitted field is left alone; `structured_data` REPLACES the stored object rather than merging into it.
  - `content` string, nullable: The document body.
  - `structured_data` object, nullable: The machine-readable half. Replaces, does not merge.

## Response `200`

Successful Response

- ApiResponseDocumentPayload
  - `data` DocumentPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)