API Docs / Schemas / UpdateClientDocumentRequest

UpdateClientDocumentRequest

Properties

Name Type Description
documentCategoryCodestring

The document category code. Optional — if omitted, the document will have no category assigned.

The document category code. Optional — if omitted, the document will have no category assigned.

titlestring

The title of the document

The title of the document

summarystring

A brief summary or description of the document

A brief summary or description of the document

datestring

The date the document is dated (not the creation date)

The date the document is dated (not the creation date)

visibleInClientPortalboolean

Whether this document is visible to the client in the portal. Defaults to true.
Does not affect visibility in external storage providers — only controls portal access.

Whether this document is visible to the client in the portal. Defaults to true.
Does not affect visibility in external storage providers — only controls portal access.

portalFolderPathstring

Folder path controlling where this document appears in the client portal.
Format: "folderId:FolderName/folderId:FolderName".
Null or empty for root-level. Only applies to portal display — does not move the physical file.

Folder path controlling where this document appears in the client portal.
Format: "folderId:FolderName/folderId:FolderName".
Null or empty for root-level. Only applies to portal display — does not move the physical file.

JSON Example

{
  "documentCategoryCode": "string",
  "title": "string",
  "summary": "string",
  "date": "2024-01-01",
  "visibleInClientPortal": false
}

Used By Operations