Update Document via ID

Update a single document by its unique identifier with the given information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Document identifier

Body Params

Multipart payload with the document's fields plus an optional file part to replace its attachment, or removeFile=true to clear it.

Raw payload collected from the multipart request body of PATCH /v1/documents/{id}.
Validation and conversion into an UpdateDocument happens in into_update_document.
All fields are optional; omit a field to leave it unchanged. Fields marked nullable can be
cleared by sending an empty value.

int64 | null
string | null

Description of the changes in this version. Omit to preserve it; empty clears it.

string | null
file | null

Binary file content to replace the existing attachment. Accepted types: PDF, DOCX, XLSX,
PPTX.

location_ids
array of int64s | null
location_ids
main_trade_ids
array of int64s | null
main_trade_ids
string | null
string | null
boolean

Set to true to remove the existing file attachment without uploading a new one.

int64 | null
int64 | null
team_ids
array of int64s | null
team_ids
Responses

400

Validation error

401

Unauthorized

403

Forbidden

404

Document not found

413

Payload too large

500

Unexpected error during document update

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json