Skip to main content
PATCH
/
v1
/
public
/
files
/
{file_id}
Update file metadata
curl --request PATCH \
  --url https://api.poelis.com/v1/public/files/{file_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userTitle": "<string>",
  "description": "<string>"
}
'
{
  "content_type": "application/pdf",
  "deleted": false,
  "description": "Specification document for compressor performance and operating constraints.",
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "originalFileName": "compressor-spec-v3.pdf",
  "size_bytes": 245612,
  "uploadedBy": {
    "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
    "imageUrl": "https://example.com/avatar.png",
    "userName": "Jane Doe"
  },
  "uploaded_at": "2026-04-01T10:11:12.123Z",
  "used_in": [
    {
      "file_link_id": "890e8400-e29b-41d4-a716-446655440000",
      "product_id": "660e8400-e29b-41d4-a716-446655440000",
      "target_id": "770e8400-e29b-41d4-a716-446655440000",
      "target_type": "item"
    }
  ],
  "userTitle": "Compressor specification"
}

Documentation Index

Fetch the complete documentation index at: https://docs.poelis.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
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

User who uploaded the file

Example:
{
  "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
  "imageUrl": "https://example.com/avatar.png",
  "userName": "Jane Doe"
}
​
used_in
PublicFileUsage · object[]

Current file link placements for this file