AXaxilioai
files

Update a file

Changed on

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}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-Axilio-Api-Key

Path parameters

file_idstring uuid required

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",
  "file": {
    "$schema": "/api/v1/FileSummary.json"
  }
}

Changes

  • 49b1da5a7974Revision changes
    • warning

      added the new message enum value to the / response property for the response status

    • info

      api operation id files_rename removed and replaced with files_update

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 8a66f81813b3Revision changes
    • info

      endpoint added