Get Upload URL

scope files:create

Get a pre-signed URL for uploading a file to your Account storage. This endpoint returns a secure URL that allows you to upload files directly to S3 storage, which can then be used in Business Processes or customer interactions.

The service supports various file types including PDFs, images, and text files. Files are organized in a virtual directory structure that can be accessed via both API and SFTP.

Info

Files uploaded via this API can be accessed via SFTP in the /files virtual directory, and files uploaded via SFTP can be accessed via this API.

The pre-signed URL is valid for a limited time and should be used immediately for file upload.

Warning

Ensure your file content matches the specified contentType and fileName. The service validates file extensions against content types.

After uploading, you can reference the file in Business Processes actions or download it via the Get File endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier (AVID) of the Account.

Body Params
string
required
length ≥ 1

The name of the file to be uploaded

string
enum
required

The content type of the file to be uploaded

Allowed:
string
length ≥ 1

A description of the file to be uploaded

string
length ≥ 1

The business process to be associated with the file

string
length ≥ 1

The business process action to be associated with the file

string
Defaults to 60d

The expiration of the file. A string representing time with a unit (h=hour, d=days, m=minutes)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json