Skip to main content
PUT
Update file metadata or retention

Authorizations

X-Public-Key
string
header
required

Public half of the company API key. Format: pk_ followed by 64 hexadecimal characters.

X-Secret-Key
string
header
required

Secret half of the company API key. Format: sk_ followed by 64 hexadecimal characters. Stored as a hash server-side and shown only at creation or rotation.

Path Parameters

fileId
string<uuid>
required

File identifier.

Body

application/json

Strict schema. Unknown keys are rejected.

name
string

Display name, without the extension.

Required string length: 1 - 255
visibility
enum<string>
Available options:
private,
public
retentionPeriod
enum<string>
Available options:
30d,
45d,
90d,
120d,
180d,
1Y,
2Y,
3Y,
5Y
metadata
object

Free-form metadata object. Tags are managed through dedicated dashboard flows.

version
integer

Client-side optimistic-concurrency token. Accepted but not trusted for writes.

Required range: x >= 1

Response

Updated file.

status
integer
required
Example:

200

message
string
required
Example:

"File updated"

data
object
required

File record. Additional fields may be present; undocumented fields are not a stable contract.