Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Files

Update file properties

Update properties of file by ID.

patch/files/2026-03/files/{fileId}

Path parameters

fileIdstring required

Request body

access'HIDDEN_INDEXABLE' | 'HIDDEN_NOT_INDEXABLE' | 'HIDDEN_PRIVATE' | 'HIDDEN_SENSITIVE' | 'PRIVATE' | 'PUBLIC_INDEXABLE' | 'PUBLIC_NOT_INDEXABLE' | 'SENSITIVE'

NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.

clearExpiresboolean required
expiresAtstring date-time
isUsableInContentboolean

Mark whether the file should be used in new content or not.

namestring

New name for the file.

parentFolderIdstring

FolderId where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.

parentFolderPathstring

Folder path where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.

Response

successful operation

access'HIDDEN_INDEXABLE' | 'HIDDEN_NOT_INDEXABLE' | 'HIDDEN_PRIVATE' | 'HIDDEN_SENSITIVE' | 'PRIVATE' | 'PUBLIC_INDEXABLE' | 'PUBLIC_NOT_INDEXABLE' | 'SENSITIVE'

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.

archivedboolean required

If the file is deleted.

archivedAtstring date-time

Deletion time of the file object.

createdAtstring date-time required

Creation time of the file object.

defaultHostingUrlstring

Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.

encodingstring

Encoding of the file.

expiresAtinteger
extensionstring

Extension of the file. ex: .jpg, .png, .gif, .pdf, etc.

fileMd5string

The MD5 hash of the file.

heightinteger

For image and video files, the height of the content.

idstring required

File ID.

isUsableInContentboolean

Previously "archied". Indicates if the file should be used when creating new content like web pages.

namestring

Name of the file.

parentFolderIdstring

ID of the folder the file is in.

pathstring

Path of the file in the file manager.

sizeinteger

Size of the file in bytes.

sourceGroup'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'
typestring

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.

updatedAtstring date-time required

Timestamp of the latest update to the file.

urlstring

URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.

widthinteger

For image and video files, the width of the content.