Files

Update a file

Renames a file you can edit or changes its notes: a file you own, or one shared with you with edit (update) permission. Omitted fields are left unchanged. Unknown body fields are rejected. The response is the file summary, with no download_url: fetch the bytes from GET /api/v1/files/{id}, which requires files:read.

patch/api/v1/files/{id}

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/files/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

file_namestring
notesstring

Example request

{
  "file_name": "q3-notes.pdf"
}

Response

The updated file summary.

idstring required
file_namestring required
mime_typestring required
file_sizenumber required
moderation_status'pending' | 'scanning' | 'clean' | 'blocked' | 'null' nullable required
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.