There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Upload a replacement file

Last updated May 31, 2023

POST /filemanager/api/v3/files/:file_id/replace

Method Details

HTTP Methods:

POST

Content Type:

multipart/form-data

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

files

Replace a specific file in file manager, specified by the file ID.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
file_id Used in the request URL Unique identifier for a particular file

Allowed Fields in the body

Parameter name Type Description
file File data The multi-part form encoded file to upload.
charSetHunch String Optional field. The character set of the provided file.
options JSON object Required field. JSON string representation of the options object. See below.

options object

Field name Description
access
(enum)		 Required field. Options are:

PUBLIC_INDEXABLE
The file will be publicly accessible by anyone who has the file url. Search engines will be able to index the file.

PUBLIC_NOT_INDEXABLE
The file will be publicly accessible by anyone who has the file url. The X-Robots-Tag: noindex header will be sent whenever the file is retreived, instructing search engines not to index the file.

PRIVATE
The file will be private and requires a signed url to access. Search engines will NOT be able to index the file.
ttl
(string)		 Time to live. Optional field. If specified the file will be deleted after the specified amount of time. The formats are Periods. For example “P3M” means a period of 3 monts. The file will be deleted after 3 months. The ttl cannot be more than 1 year.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
# This example updates the existing file with ID 33067666776 # And replaces it with the contents of the local file named example_file.txt import requests import json post_url = 'https://api.hubapi.com/filemanager/api/v3/files/33067666776/replace' filename = 'example_file.txt' file_options = { 'access': 'PUBLIC_INDEXABLE', 'ttl': 'P3M' } files_data = { 'file': (filename, open(filename, 'rb'), 'application/octet-stream'), 'options': (None, json.dumps(file_options), 'text/strings') } r = requests.post(post_url, files = files_data) print(r) print(r.content)
# This example updates the existing file with ID 33067666776 # And replaces it with the contents of the local file named example_file.txt require 'http' require 'json' post_url = "https://api.hubapi.com/filemanager/api/v3/files/33067666776/replace?hapikey=demo" filename = "example_file.txt" file_options = { "access" => "PUBLIC_INDEXABLE", "ttl" => "P3M" } response = HTTP.post(post_url, :form => { file: HTTP::FormData::File.new(filename), options: JSON.generate(file_options) }) puts response.code puts response.to_s
<?php // This example updates the existing file with ID 33067666776 // And replaces it with the contents of the local file named example_file.txt $post_url = "https://api.hubapi.com/filemanager/api/v3/files/33067666776/replace?hapikey=demo"; $upload_file = new CURLFile('example_file.txt','application/octet-stream'); $file_options = array( "access" => "PUBLIC_INDEXABLE", "ttl" => "P3M" ); $post_data = array( "file" => $upload_file, "options" => json_encode($file_options) ); $ch = curl_init(); @curl_setopt($ch, CURLOPT_POST, true); @curl_setopt($ch, CURLOPT_URL, $post_url); @curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data); $response = @curl_exec($ch); //Log the response from HubSpot as needed. $status_code = @curl_getinfo($ch, CURLINFO_HTTP_CODE); //Log the response status code @curl_close($ch); echo $status_code . " " . $response; ?>
# This example updates the existing file with ID 33067666776 # And replaces it with the contents of the local file named example_file.txt # create a variable for the file options JSON fileOptions=$(cat <<EOF { "access": "PUBLIC_INDEXABLE", "ttl": "P3M" } EOF ) curl -v \ -F "file=@example_file.txt;type=application/octet-stream" \ -F "options=$fileOptions;type=text/strings" \ https://api.hubapi.com/filemanager/api/v3/files/upload?hapikey=demo
// This example updates the existing file with ID 33067666776 // And replaces it with the contents of the local file named example_file.txt var request = require('request'); var fs = require('fs'); var postUrl = 'https://api.hubapi.com/filemanager/api/v3/files/33067666776/replace?hapikey=demo'; var filename = 'example_file.txt'; var fileOptions = { access: 'PUBLIC_INDEXABLE', ttl: 'P3M' }; var formData = { file: fs.createReadStream(filename), options: JSON.stringify(fileOptions) }; request.post({ url: postUrl, formData: formData }, function optionalCallback(err, httpResponse, body){ return console.log(err, httpResponse.statusCode, body); });