/bff/drive/rename

Renames a file in the database only (the physical blob storage path is not changed). The file extension cannot be changed — it is validated against the original. The new name is sanitized to ASCII and must be unique within the same folder. The file is not moved to a different directory.

DrivepostBffDriveRename

Parameters

JSON body

Request body

application/json

tokenstringRequired

Unique file token identifying the file to rename.

ExampleaB3xKm9pQ2wLn4Yz

filenamestringRequired

New file name. Can be provided with or without extension. The original extension is always preserved — if a different extension is provided, the request is rejected. The name is automatically sanitized: converted to ASCII, lowercased, spaces replaced with hyphens, and invalid characters removed.

Length: 1–∞

Examplesmonthly-reportinvoice-2026-03.pdf

Response schema

1 status code documented

200SuccessResult of the rename operation.

tokenstringRequired

File token (unchanged).

filenamestringRequired

New sanitized filename (including extension).

changedbooleanRequired

Whether the filename actually changed (false if same as before).

Response example

application/json

{
  "token": "example_token",
  "filename": "example_filename",
  "changed": false
}

Request example

POST /bff/drive/rename

post

curl -X POST "https://api.bizkithub.com/bff/drive/rename" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "token": "aB3xKm9pQ2wLn4Yz",
  "filename": "monthly-report"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key