Create Folder

Create new folder within shared folder.

Endpoint

POST /api/v1/shares/{token}/items

Parameters

Path parameters

Parameter	Type	Required	Description
token	string	yes	-

Body parameters

Parameter	Type	Required	Description
name	string	yes	The name of the new folder
parent_id	uuid	no	The id of the parent folder, if not set, then the folder will be created in the home directory of the shared folder

Request example

cURL

curl --location --request POST 'https://files.ro/api/v1/shares/{token}/items' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "New Folder"
}'

Response

201 Created

{
  "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"
          }
        }
      }
    }
  }
}

403 Forbidden

{
  "type": "error",
  "message": "Access Denied"
}

422 Unprocessable Entity

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