Rename Item

Rename file or folder.

Endpoint

PATCH /api/v1/items/{item_id}

Parameters

Path parameters

Parameter	Type	Required	Description
item_id	string	yes	-

Body parameters

Parameter	Type	Required	Description
name	string	yes	The new item name
type	string	yes	The type of the renaming item. Allowed types are folder or file

Request example

cURL

curl --location --request PATCH 'https://files.ro/api/v1/items/{item_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
  "name": "New Folder",
  "type": "folder"
}'

Response

200 OK

{
  "data": {
    "id": "folder_123",
    "type": "folder",
    "attributes": {
      "name": "Projects",
      "color": "#00BC7E",
      "emoji": null,
      "filesize": 12345678,
      "isTeamFolder": false,
      "items": 12,
      "trashed_items": 0,
      "created_at": "01. Jan. 2024",
      "updated_at": "02. Jan. 2024",
      "deleted_at": null
    },
    "relationships": {
      "shared": {
        "data": {
          "id": "share_123",
          "type": "shared",
          "attributes": {
            "permission": "editor",
            "protected": false,
            "item_id": "item_123",
            "expire_in": 24,
            "token": "share_token",
            "link": "https://files.ro/share/share_token",
            "type": "folder"
          }
        }
      },
      "parent": {
        "data": {
          "type": "folder",
          "id": "folder_root",
          "attributes": {
            "name": "Root"
          }
        }
      },
      "user": {
        "data": {
          "type": "user",
          "id": "user_123",
          "attributes": {
            "name": "Jane Doe",
            "avatar": "https://files.ro/storage/avatars/jane.png",
            "color": "#00BC7E"
          }
        }
      }
    }
  }
}

401 Unauthorized

{
  "type": "error",
  "message": "You are not authorized"
}

422 Unprocessable Entity

{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is required."
    ]
  }
}