Skip to content

Update Deal Document

PUT
/deals/{deal_id}/documents/{document_id}

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.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id (UUID).

string

Deal id (UUID).

document_id
required

Document id, from the list read.

string

Document id, from the list read.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
content
Any of:
string
structured_data
Any of:
object
key
additional properties
any

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string