v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Folders

Update a folder

Update a folder's display name and/or URL path segment. At least one of name or path must be provided. Changing the name does not automatically update the path. When the path is updated, descendant folder paths are cascaded.

patch/api/v1/folders/{folderId}

Path parameters

folderIdstring uuid required

Unique identifier for the folder

Example:550e8400-e29b-41d4-a716-446655440000

Unique identifier for the folder

Request body

breadcrumbRootboolean

When true, breadcrumbs for content in this folder start at this folder, hiding parent folders

namestring

New display name for the folder

pathstring

New URL path segment for the folder (alphanumeric and dashes only). This is only the folder's own segment, not the full hierarchical path.

resolvePathConflictboolean

When true, automatically resolves path collisions with existing folders by appending a numeric suffix (e.g., my-path-1). When false (default), returns 409 Conflict if the path is already taken. Does not apply to reserved paths, which are always rejected with 400.

Example request

{
  "name": "Q1 Reports",
  "path": "q1-reports"
}

Response

Folder updated successfully

breadcrumbRootboolean required

Whether breadcrumbs start at this folder

idstring uuid required

Folder ID

namestring required

Updated folder name

pathstring required

Updated URL path segment for the folder (the folder's own segment only)