Skip to main content
PATCH
Update file

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

fileId
string<uuid>
required

Unique identifier of the file.

Body

application/json

Request to update file metadata.

Request to update file metadata.

displayName
string

New display name for the file.

Required string length: 1 - 255
metadata
any

Updated metadata.

Response

Represents a file in responses.

Represents a file in responses.

createdAt
string<date-time>
required

Creation timestamp.

displayName
string
required

Display name.

fileExtension
string
required

File extension (without dot).

fileKind
required

The file's role (original, redacted, audit).

Allowed value: "original"
fileSize
integer<int64>
required

File size in bytes.

id
string<uuid>
required

Unique file identifier.

originalFilename
string
required

Original filename when uploaded.

updatedAt
string<date-time>
required

Last update timestamp.

uploadedBy
object
required

Account that uploaded/created the file.

versionNumber
integer<int32>
required

Version number (1 for original, higher for newer versions).

workspaceSlug
string
required

Handle of the workspace this file belongs to.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
parentId
string<uuid>

Parent file ID if this is a newer version.