Skip to main content
POST
Create a File

Authorizations

X-API-KEY
string
header
required

Path Parameters

fileType
string
required

The type of file object to be created. This can be 'file', 'folder', or 'link'.

Body

application/json

File to create

channelID
string
required

ChannelID is the file channel the item is created in.

Example:

"a8f2c1d4-1234-4abc-9def-0123456789ab"

type
enum<string>
required

Type is the kind of item to create. Defaults to "file" when omitted on the path.

Available options:
file,
folder,
link
Example:

"file"

clientPermissions
enum<string>

ClientPermissions sets the folder locking permissions for the created file/folder

Available options:
read_write,
read_only
Example:

"read_write"

duplicateBehavior
enum<string>

DuplicateBehavior specifies how to handle if a file with the same name already exists at the path. Defaults to "append" (keep both) when omitted.

Available options:
append,
replace
Example:

"append"

fileKey
string

FileKey is the S3 object key for an already-uploaded file's binary data.

Example:

"files/a8f2c1d4/2024-01-02T15:04:05Z/brochure.pdf"

FileURL is the external link target. Required when creating a link.

Example:

"https://example.com/brochure.pdf"

path
string

Path is the folder location for the item. Required when creating a folder.

Example:

"/contracts/2024"

Response

OK

additionalFields
object
channelId
string

ChannelID is the file channel the item belongs to.

Example:

"a8f2c1d4-1234-4abc-9def-0123456789ab"

clientPermissions
enum<string>

ClientPermissions controls client read/write access for folders.

Available options:
read_write,
read_only
Example:

"read_write"

createdAt
string
creatorId
string

CreatorId is the id of the user who created the file.

Example:

"f4a1b2c3-1234-4abc-9def-0123456789ab"

data
string
downloadUrl
string<uri>

DownloadURL is a presigned URL for downloading the file's contents.

fields
object

Fields holds the item's name, path, link target, size, and status.

id
string
identityId
string
lastModifiedBy
object

LastModifiedBy identifies the user who last modified the file.

object
string
previousAttributes
object
ref
string
updatedAt
string<date-time>

UpdatedDate is when the file was last updated.

uploadUrl
string<uri>

UploadURL is a presigned URL for uploading the file's binary data, set on creation of an unuploaded file.