API Docs / Schemas / BulkTrackExternalFilesRequest

BulkTrackExternalFilesRequest

Tracks multiple existing external files in Sodium, creating a ClientDocument record for each.
No file upload — the files already live in the external storage provider. Titles are derived
from the file names.

Properties

Name Type Description
files*array of TrackExternalFileItemDto

The external files to track. Duplicates are ignored.

The external files to track. Duplicates are ignored.

documentCategoryCodestring

The document category code to apply to every tracked file. Optional — unknown or omitted codes leave the documents uncategorised.

The document category code to apply to every tracked file. Optional — unknown or omitted codes leave the documents uncategorised.

visibleInClientPortalboolean

Whether the tracked documents are visible in the client portal. Defaults to true, matching the single-file track flow.

Whether the tracked documents are visible in the client portal. Defaults to true, matching the single-file track flow.

portalFolderPathstring

Folder path controlling where the documents appear in the client portal, "/" separated.
Usually the storage folder the files are being tracked from, so the portal mirrors the
storage layout. Null or empty for the portal root.

Folder path controlling where the documents appear in the client portal, "/" separated.
Usually the storage folder the files are being tracked from, so the portal mirrors the
storage layout. Null or empty for the portal root.

JSON Example

{
  "files": [
    {
      "externalFileId": "...",
      "fileName": "...",
      "fileSize": "..."
    }
  ],
  "documentCategoryCode": "string",
  "visibleInClientPortal": false,
  "portalFolderPath": "string"
}

Used By Operations