Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Folders

Create folder

Create a new folder. Folders can be nested up to 7 levels.

Folder paths are automatically generated based on hierarchy. Child folder paths include the paths of their parents.

post/v1/folders

Request body

namestring required

Name of the folder.

parentFolderIdstring uuid

ID of the parent folder. Use the List folders endpoint to retrieve folder IDs.

Maximum nesting depth is 7 levels. A 400 error is returned when the limit is reached.

scope'organization' | 'restricted'

Scope of the folder.

  • If no scope is provided and no parent folder exists, defaults to organization
  • If no scope is provided but a parent folder exists, inherits the parent folder's scope
  • Child folder scope must match the parent folder's scope
userIdstring uuid

ID of the folder owner. Use the List users or List embed users endpoints to retrieve user IDs.

breadcrumbRootboolean

When true, breadcrumbs for this folder and its descendants start at this folder, hiding ancestor folders and the scope crumb (Shared, <name>'s Documents).

This is useful for scoping navigation to a subtree, for example in embed use cases built around a specific contentPath folder.

Response

Folder created successfully

idstring uuid

Unique identifier for the folder

namestring

Display name of the folder

pathstring

Full path to the folder

scope'organization' | 'restricted'

Visibility scope of the folder

ownerIdstring

ID of the user that owns the folder

breadcrumbRootboolean

Whether breadcrumbs start at this folder