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 reference]

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.

AccessType

YES

Option	Value
PRIVATE	PRIVATE
PUBLIC_NOT_INDEXABLE	PUBLIC_NOT_INDEXABLE
PUBLIC_INDEXABLE	PUBLIC_INDEXABLE

Specify file access type

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

YES

Option	Value
NONE	NONE
REJECT	REJECT
RETURN_EXISTING	RETURN_EXISTING

Specify how to handle duplicate target file.

DuplicateValidationScope

YES

Option	Value
EXACT_FOLDER	EXACT_FOLDER
ENTIRE_PORTAL	ENTIRE_PORTAL

Specify scope of duplicate validation.

TargetFileName

Target File Name (e.g. MyFile.xlsx)

Specify file name you like to give

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I8`	`bigint`		`False`
PortalId	`DT_I8`	`bigint`		`False`
Name	`DT_WSTR`	`nvarchar(50)`	50	`False`
Size	`DT_I8`	`bigint`		`False`
Height	`DT_I4`	`int`		`False`
Width	`DT_I4`	`int`		`False`
Encoding	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Type	`DT_WSTR`	`nvarchar(50)`	50	`False`
Extension	`DT_WSTR`	`nvarchar(50)`	50	`False`
CloudKey	`DT_WSTR`	`nvarchar(500)`	500	`False`
S3Url	`DT_WSTR`	`nvarchar(500)`	500	`False`
FriendlyUrl	`DT_WSTR`	`nvarchar(500)`	500	`False`
AltKey	`DT_WSTR`	`nvarchar(500)`	500	`False`
AltKeyHash	`DT_WSTR`	`nvarchar(500)`	500	`False`
Title	`DT_WSTR`	`nvarchar(50)`	50	`False`
MetaUrlScheme	`DT_WSTR`	`nvarchar(50)`	50	`False`
MetaAllowsAnonymousAccess	`DT_BOOL`	`bit`		`False`
MetaIndexable	`DT_BOOL`	`bit`		`False`
Created	`DT_DBTIMESTAMP`	`datetime`		`False`
Updated	`DT_DBTIMESTAMP`	`datetime`		`False`
DeletedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
FolderId	`DT_I8`	`bigint`		`False`
Hidden	`DT_BOOL`	`bit`		`False`
CloudKeyHash	`DT_WSTR`	`nvarchar(500)`	500	`False`
Archived	`DT_BOOL`	`bit`		`False`
CreatedBy	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
DeletedBy	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Replaceable	`DT_BOOL`	`bit`		`False`
Url	`DT_WSTR`	`nvarchar(500)`	500	`False`
AltUrl	`DT_WSTR`	`nvarchar(500)`	500	`False`
CdnPurgeEmbargoTime	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
FileHash	`DT_WSTR`	`nvarchar(1020)`	1020	`False`

If the column you are looking for is missing, consider customizing Hubspot Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Hubspot Connector in API Source component to read data or in API Destination component to read/write data:

Upload File from Local Disk using API Source

Hubspot

Upload File from Local Disk

SSIS API Source - Read from table or endpoint

Upload File from Local Disk using API Destination

Hubspot

Upload File from Local Disk

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Upload file from local disk

SELECT * FROM upload_file
WITH
(
    "SourceFilePath" = 'abcd-1234-sourcefilepath',
    "TargetFolder" = '/',
    "AccessType" = 'PRIVATE',
    "Overwrite" = 'true',
    "DuplicateValidationStrategy" = 'NONE',
    "DuplicateValidationScope" = 'EXACT_FOLDER'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Upload file from local disk

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM upload_file
WITH
(
    "SourceFilePath" = ''abcd-1234-sourcefilepath'',
    "TargetFolder" = ''/'',
    "AccessType" = ''PRIVATE'',
    "Overwrite" = ''true'',
    "DuplicateValidationStrategy" = ''NONE'',
    "DuplicateValidationScope" = ''EXACT_FOLDER''
)';

EXEC (@MyQuery) AT [LS_TO_HUBSPOT_IN_GATEWAY];