TrackExternalFileRequest
Request to track an existing external file in our system, creating a ClientDocument
record that references the file by its platform-specific ID. No file upload required.
Properties
| Name | Type | Description |
|---|---|---|
| externalFileId | string | The platform-specific file identifier (e.g., Box file ID) |
The platform-specific file identifier (e.g., Box file ID) | ||
| fileName | string | The original file name from the provider |
The original file name from the provider | ||
| fileSize | integer | File size in bytes |
File size in bytes | ||
| title | string | The title for the document in Sodium |
The title for the document in Sodium | ||
| summary | string | A brief summary or description |
A brief summary or description | ||
| date | string | The date the document is dated |
The date the document is dated | ||
| documentCategoryCode | string | The document category code |
The document category code | ||
| visibleInClientPortal | boolean | Whether this document is visible in the client portal |
Whether this document is visible in the client portal | ||
JSON Example
{
"externalFileId": "string",
"fileName": "string",
"fileSize": 0,
"title": "string",
"summary": "string"
}