Skip to main content

Create a folder

Create a folder.

Parameters​

name
string
required
Name for the folder
visibility
enum
required
Visibility of the folder. One of private, internal, shared.
role
enum
Only when visibility is internal. Used as the default role for all team members. If a user has a directly attached role, it will override this one. One of folder_admin, folder_manager, folder_creator, folder_commenter, folder_uploader, folder_viewer.
description
string
Description for the folder
folder
string
Unique identifier for the folder in which the folder will be created.
template
string
ID of the template
clone
object
Options for cloning the template. If no options are provided, the entire template will be cloned.

Returns​

Returns the created folder object. Throws an error if some parameters are not valid.

post
/api/folders
curl -X POST https://{workspace}.kitchen.co/api/folders \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "archived_at": null,
  "created_at": "2024-03-12T14:18:37+00:00",
  "id": "fo_19b9108c92d98f81224ece44",
  "name": "New Folder",
  "description": null,
  "updated_at": "2024-03-12T14:18:37+00:00",
  "visibility": "shared"
}