Skip to main content
POST
Upload File

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

multipart/form-data
file
file
required

The file content to upload

fileName
string
required

File name (must be non-empty)

mimeType
string
required

MIME type of the file (e.g. application/pdf)

category
string

Optional category label

folderId
string<uuid>

Folder ID to place the file in (omit for root-level)

Response

File uploaded successfully

A file stored in the company file system

id
string<uuid>

File identifier

name
string

File name

mimeType
string | null

MIME type of the file

category
string | null

Optional category label

entityId
string | null

Related entity ID (if attached to an entity)

entityName
string | null

Related entity name (if attached to an entity)

uploadedAt
string<date-time> | null

When the file was uploaded (ISO 8601)

userDate
string<date-time> | null

User-specified date for the file (ISO 8601)