EndPoint Upload File from Local Disk
Name
upload_file
Description
Uploads local file to Hubspot CRM. This API requires files permission for the App (see scopes)
[API Help]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| SourceFilePath |
Source File Path |
YES |
|
Specify a disk file path
|
| TargetFolder |
Target Folder Path |
YES |
|
Specify Target folder path. Partially optional field. One of folderPath or folderId must be specified. Path of the folder the file should be uploaded into. Uploading files into the root path “/” is highly discouraged.
|
| TargetFileName |
Target File Name (e.g. MyFile.xlsx) |
NO |
|
Specify file name you like to give
|
| AccessType |
AccessType |
YES |
| Option |
Value |
| PRIVATE |
PRIVATE |
| PUBLIC_NOT_INDEXABLE |
PUBLIC_NOT_INDEXABLE |
| PUBLIC_INDEXABLE |
PUBLIC_INDEXABLE |
|
Specify file access type
|
| Overwrite |
Overwrite |
YES |
| Option |
Value |
| false |
false |
| true |
true |
|
Specify wheather you like to overwrite target file if exists. If true this file with replace any existing files with the name, folder, and type. Note: If this is set to false, and the uploaded file matches the filename of an existing file in the same folder, the file will be uploaded with a number incremented filename (e.g. example_file.txt will become example_file-1.txt)
|
| DuplicateValidationStrategy |
DuplicateValidationStrategy |
YES |
| Option |
Value |
| NONE |
NONE |
| REJECT |
REJECT |
| RETURN_EXISTING |
RETURN_EXISTING |
|
Specify how to handle duplicate target file.
|
| DuplicateValidationScope |
DuplicateValidationScope |
YES |
| Option |
Value |
| EXACT_FOLDER |
EXACT_FOLDER |
| ENTIRE_PORTAL |
ENTIRE_PORTAL |
|
Specify scope of duplicate validation.
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_I8 |
0 |
False |
|
| PortalId |
DT_I8 |
0 |
False |
|
| Name |
DT_WSTR |
50 |
False |
|
| Size |
DT_I8 |
0 |
False |
|
| Height |
DT_I4 |
0 |
False |
|
| Width |
DT_I4 |
0 |
False |
|
| Encoding |
DT_WSTR |
1020 |
False |
|
| Type |
DT_WSTR |
50 |
False |
|
| Extension |
DT_WSTR |
50 |
False |
|
| CloudKey |
DT_WSTR |
500 |
False |
|
| S3Url |
DT_WSTR |
500 |
False |
|
| FriendlyUrl |
DT_WSTR |
500 |
False |
|
| AltKey |
DT_WSTR |
500 |
False |
|
| AltKeyHash |
DT_WSTR |
500 |
False |
|
| Title |
DT_WSTR |
50 |
False |
|
| MetaUrlScheme |
DT_WSTR |
50 |
False |
|
| MetaAllowsAnonymousAccess |
DT_BOOL |
0 |
False |
|
| MetaIndexable |
DT_BOOL |
0 |
False |
|
| Created |
DT_DBTIMESTAMP |
0 |
False |
|
| Updated |
DT_DBTIMESTAMP |
0 |
False |
|
| DeletedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| FolderId |
DT_I8 |
0 |
False |
|
| Hidden |
DT_BOOL |
0 |
False |
|
| CloudKeyHash |
DT_WSTR |
500 |
False |
|
| Archived |
DT_BOOL |
0 |
False |
|
| CreatedBy |
DT_WSTR |
1020 |
False |
|
| DeletedBy |
DT_WSTR |
1020 |
False |
|
| Replaceable |
DT_BOOL |
0 |
False |
|
| Url |
DT_WSTR |
500 |
False |
|
| AltUrl |
DT_WSTR |
500 |
False |
|
| CdnPurgeEmbargoTime |
DT_WSTR |
1020 |
False |
|
| FileHash |
DT_WSTR |
1020 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
