Upload a new file

Last updated July 15, 2020

POST /filemanager/api/v2/files

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?





Marketing & CRM

Required Scope:


Upload a new file to the file manager. This endpoint uses multi-part form encoding, rather than JSON.

On success, the response will include the metadata for the file.  See this page for an example.

Files uploaded with the optional parameter hidden set to true will be inaccessible via the file manager or the URLs returned in the response. The hidden parameter is intended for files that are attached to engagements. Changing hidden from false to true will NOT hide existing files.

Note: Files that contain sensitive or confidential information should not be uploaded to file manager, as all uploaded files are stored on a public CDN where the files can be accessed by anyone with the file URL. These publicly accessible files will also be indexed by Google.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional query string options

Parameter name Description
overwrite Set to 'true' if you want to overwrite a file of the same name. If false, will append a number to the file name and create a new file.
hidden Set to 'true' if the file should be hidden/inaccessible via the file manager. Should normally be omitted; hidden files can be included as attachments to engagements.

Allowed Fields in the body

Parameter name Type Description
file_names string The file name of the file you are uploading. Leave empty to use the original file name
files File data The multi-part form encoded file to upload.
folder_paths string The path within file manager to the folder you want to upload the files into.
folder_ids long The ID of the folder you are uploading to. Leave blank to send file to root directory.