Sign in
files

Rename a file

Updates the file's display name. Metadata only: storage is keyed by id, so the object never moves and existing URLs keep working, and past deliveries keep the name they were sent under. Only an uploaded file can be renamed; a captured file's name is part of its provenance, so renaming one is rejected.

patch/files/{file_id}

Path parameters

file_idstring uuid required

file identifier to rename

file identifier to rename

Request body

$schemastring uri

A URL to the JSON Schema for this object.

filenamestring required

New display name for the file.

Example request

{
  "$schema": "/api/v1/FileRenameRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "/api/v1/RenameFileOutputBody.json"
}

Changes