api.documents.update

PUT /documents/update/{docId} — ACPortal

Python

api.documents.update(doc_id: str, *, data: DocumentUpdateRequest | dict) -> None

CLI

ab documents update <doc_id> [--data ...]

PUT /documents/update/{docId}.

Args: doc_id: Document identifier. data: Document update payload. Accepts a :class:DocumentUpdateRequest instance or a dict.

Request model: :class:DocumentUpdateRequest

Request body — DocumentUpdateRequest

Field

Type

Required

Description

FileName

Optional[str]

no

Updated file name

TypeId

Optional[int]

no

Updated document type ID

Shared

Optional[int]

no

Updated sharing level

Tags

Optional[list[str]]

no

Free-form tags to attach to the document.

JobItems

Optional[list[str]]

no

Associated job item UUIDs.

Response

No response body.


← Back to api.documents