Create Team Folder

Create new Team Folder and invite new members into it.

Endpoint

POST /api/v1/teams/folders

Parameters

Body parameters

Parameter	Type	Required	Description
name	string	yes	The name of the team folder.
invitations	array	yes	The array of invitations which specify who invite to the team folder.
invitations.*.email	string	yes	The email address of the user
invitations.*.permission	string	yes	The permission for the user. Can be can-edit or can-view
invitations.*.type	string	yes	The type of the object, invitation value is required

Request example

cURL

curl --location --request POST 'https://files.ro/api/v1/teams/folders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
  "name": "Team API",
  "invitations": [
    {
      "email": "jane@doe.com",
      "permission": "can-edit",
      "type": "invitation"
    }
  ]
}'

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": "This user action is not allowed."
}

403 Forbidden

{
  "type": "error",
  "message": "You exceed your members limit."
}

401 Unauthorized

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

422 Unprocessable Entity

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