Skip to content

HubSpot: Update file — files replace By File Id

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

← Files operations · Get started

Operation hubspot.files_replace_by_file_id

Provider route: PUT /files/2026-09/files/{fileId}. 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"]["replaceByFileId"]>[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.replaceByFileId(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.replace_by_file_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.fileIdstringRequired within parentPattern: \d+
bodyobjectOptional
body.charsetHunchstringOptional
body.fileobjectOptionalAdditional keys: not allowed
body.file.filenamestringRequired within parentMinimum length: 1
body.file.content_typestringRequired within parentMinimum length: 1
body.file.content_base64stringRequired within parent
body.optionsstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Upload file — response body

Referenced models: Upload file — response body

Upload file — response body
FieldTypePresenceDescription and constraints
$objectRoot
accessstringOptionalThe access level of the file, represented as a string. Valid values include 'PUBLIC_INDEXABLE', 'PUBLIC_NOT_INDEXABLE', 'HIDDEN_INDEXABLE', 'HIDDEN_NOT_INDEXABLE', 'HIDDEN_PRIVATE', 'PRIVATE', 'HIDDEN_SENSITIVE', and 'SENSITIVE'.
Known values: HIDDEN_INDEXABLE, HIDDEN_NOT_INDEXABLE, HIDDEN_PRIVATE, HIDDEN_SENSITIVE, PRIVATE, PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, SENSITIVE
archivedbooleanRequired within parentA boolean indicating whether the file is archived.
archivedAtstringOptionalThe date and time when the file was deleted, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when the file was created, in ISO 8601 format.
Format: date-time
defaultHostingUrlstringOptionalThe static cdn URL where the file is hosted.
encodingstringOptionalThe encoding of the file.
expiresAtJSONOptional
expiresAt (anyOf 1)integerAlternativeThe expiration epoch timestamp, if set.
Format: int64
expiresAt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
extensionstringOptionalThe file extension.
fileMd5stringOptionalThe MD5 hash of the file.
heightJSONOptional
height (anyOf 1)integerAlternativeThe height of the file in pixels, applicable if the file is an image or video.
Format: int32
height (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe ID of the file.
isUsableInContentbooleanOptionalA boolean indicating whether the file can be used in content.
namestringOptionalThe name of the file.
parentFolderIdstringOptionalThe unique identifier of the parent folder containing the file, represented as a string.
pathstringOptionalThe path of the file within the file manager.
sizeJSONOptional
size (anyOf 1)integerAlternativeThe size of the file in bytes.
Format: int64
size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sourceGroupstringOptionalThe source group of the file, with possible values including 'UNKNOWN', 'CONTENT', 'FORMS', 'CONVERSATIONS', and 'UI_EXTENSIONS'.
Known values: CONTENT, CONVERSATIONS, FORMS, UI_EXTENSIONS, UNKNOWN
typestringOptionalThe type of the file. Values include: IMG, DOCUMENT, AUDIO, MOVIE, OTHER.
updatedAtstringRequired within parentThe date and time when the file was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalThe URL where the file can be accessed, represented as a string.
widthJSONOptional
width (anyOf 1)integerAlternativeThe width of the file in pixels, applicable if the file is an image or video.
Format: int32
width (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: hubspot.files_replace_by_file_id. Catalog operation: files_replace_by_file_id. 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"]

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.