Skip to content

HubSpot: Import File

HubSpot files.filesImportFromUrl: arguments, response, policy and SDK examples.

← Files operations · Get started

Operation hubspot.files_files_import_from_url

Provider route: POST /files/2026-09/files/import-from-url/async. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["files"]["filesImportFromUrl"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.files.filesImportFromUrl(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.files.files_import_from_url(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Import File — request body — body

Referenced models: Import File — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Import File — response body

Referenced models: Import File — response body

Import File — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accessstringRequired within parentSpecifies the access level of the file. Valid values include 'PUBLIC_INDEXABLE', 'PUBLIC_NOT_INDEXABLE', 'HIDDEN_INDEXABLE', 'HIDDEN_NOT_INDEXABLE', 'HIDDEN_PRIVATE', 'PRIVATE', 'HIDDEN_SENSITIVE', and 'SENSITIVE'.
One of: HIDDEN_INDEXABLE, HIDDEN_NOT_INDEXABLE, HIDDEN_PRIVATE, HIDDEN_SENSITIVE, PRIVATE, PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, SENSITIVE
duplicateValidationScopestringRequired within parentOptional: Specifies the scope for duplicate validation. Valid values include 'ENTIRE_PORTAL' and 'EXACT_FOLDER'.
One of: ENTIRE_PORTAL, EXACT_FOLDER
duplicateValidationStrategystringRequired within parentDefines the strategy for handling duplicate files. Valid values are 'NONE', 'REJECT', and 'RETURN_EXISTING'.
One of: NONE, REJECT, RETURN_EXISTING
expiresAtstringOptionalOptional: Epoch time when the file will expire, in ISO 8601 format. Do not set if the file should live indefinitely
Format: date-time
folderIdstringOptionalThe ID of the folder where the file will be stored. This or folderPath must be set
folderPathstringOptionalThe path of the folder where the file will be stored. This or FolderId must be set.
namestringOptionalThe name of the file to be imported.
overwritebooleanRequired within parentOptional boolean indicating whether to overwrite an existing file at the same location.
ttlstringOptionalDeprecated Do Not use. Optional: String representing the time-to-live for the file, same a expiresAt but takes a Period String.
urlstringOptionalThe URL from which the file will be imported.
Import File — response body
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of the import task.
linksobjectOptionalA map of link names to associated URIs related to the import task. Each entry in the map is a string.
Additional keys: see wildcard field
links.*stringAdditional keys

SDK function policy ID: hubspot.files_files_import_from_url. Catalog operation: files_files_import_from_url. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["files.ui_hidden.write", "files.write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.