DownloadFile
Downloads a file from HubSpot's file manager. Requires appropriate file access scopes.
Input
| Name | Type | Accepts Output Streams | Description |
| FileId | String | False | Unique identifier of the file to be downloaded. Required to locate the file in the HubSpot file system. |
| Size | String | False | Optional setting for image files to resize the file to specific dimensions before serving. The original file remains unchanged.
The allowed values are thumb, icon, medium, preview. |
| Upscale | Boolean | False | Indicates whether the image should be enlarged to match the requested Size if the original is smaller. Only applicable to image files.
The default value is false. |
| ExpirationSeconds | Long | False | Duration in seconds for which the generated download link remains valid. Controls the time-bound access to the file. |
| LocalPath | String | False | Path on the local file system where the downloaded file will be saved. If not provided, FileStream is used instead. |
| FileStream | String | True | Writable stream where the downloaded file data will be directed. Used when LocalPath is not specified. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Returns True if the file was downloaded or the signed URL was generated successfully. |
| Details | String | Additional information about the execution of the stored procedure, such as status messages or error context. |
| Url | String | Signed temporary URL granting access to the file. Valid for the duration specified by ExpirationSeconds. |
| ExpiresAt | Datetime | Exact timestamp indicating when the signed URL will expire and access to the file will be revoked. |
| Name | String | Original name of the downloaded file as stored in HubSpot. |
| Extension | String | File extension such as .jpg, .pdf, or .mp4 indicating the format of the file. |
| Type | String | Classification of the file based on content type. Possible values include IMG, DOCUMENT, AUDIO, MOVIE, or OTHER. |
| Size | Integer | Size of the downloaded file in bytes. |
| Height | Integer | Height of the file in pixels. Applicable to image and video files only. |
| Width | Integer | Width of the file in pixels. Applicable to image and video files only. |
| FileData | String | Base64-encoded file content returned directly if neither LocalPath nor FileStream is specified. |