Folders

Create a folder

Create a new folder for organizing files. Folders can be nested by specifying a parent_folder_id.

Org-scoped keys can create folders under non-access-controlled parents. The scope parameter requires a user-scoped key.

post/folders

Request

Request body

namestring required

Folder name (min 2 characters)

descriptionstring

Optional description

parent_folder_idstring uuid

Parent folder ID. Mutually exclusive with scope. If both are omitted, creates a top-level folder.

scope'my-files' | 'organization'

Create the folder at the root of a meta-collection. Mutually exclusive with parent_folder_id. shared-with-me is not valid for create.

Example request

{
  "name": "Q4 Contracts",
  "scope": "my-files"
}

Response

Folder created

idstring uuid required

Unique folder identifier

namestring required

Folder name

descriptionstring nullable required

Folder description, or null if unset

pathstring required

Path through ancestors visible to the requester. Inaccessible ancestors are skipped, so this may not reflect absolute depth. Use parent_folder_id to traverse hierarchy.

parent_folder_idstring uuid nullable required

Parent folder ID, or null for root

folder_typestring required

Folder type (custom, my-files, etc.)

created_atstring required

ISO 8601 creation timestamp

Example response

{
  "path": "/My Files/Contracts"
}

Changes

No recorded changes to this operation across all 1 revision of this API.