Skip to main content
POST
Create folder

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
name
string
required

Name of the folder.

parentFolderId
string<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
enum<string>
default:organization

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
Available options:
organization,
restricted
userId
string<uuid>

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

breadcrumbRoot
boolean

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

id
string<uuid>

Unique identifier for the folder

name
string

Display name of the folder

path
string

Full path to the folder

scope
enum<string>

Visibility scope of the folder

Available options:
organization,
restricted
ownerId
string

ID of the user that owns the folder

breadcrumbRoot
boolean

Whether breadcrumbs start at this folder