Skip to main content
PATCH
Update file metadata

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Path Parameters

file_id
string
required

Body

application/json
userTitle
string | null

Optional editable title for the file

description
string | null

Description text to set. Empty string clears the description.

Response

Updated file metadata and current usage links.

Public representation of a stored file.

id
string
required

File ID

name
string
required

Original file name (legacy compatibility field)

originalFileName
string
required

Original file name

deleted
boolean
required

Whether the file is soft-deleted

userTitle
string | null

Optional editable file title

content_type
string | null

MIME type

description
string | null

File description

size_bytes
integer | null

File size in bytes

uploadedAt
string | null

ISO 8601 upload timestamp

uploadedBy
PublicUser · object | null

User who uploaded the file

Example:
used_in
PublicFileUsage · object[]

Current file link placements for this file