OMomni
Folders

Update folder

<Note> This endpoint requires [**Editor** permissions or higher](/share#content-access-permissions) on the folder being updated. </Note>

Update a folder's name and/or path segment. Either or both fields can be updated in a single request.

patch/v1/folders/{folderId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/folders/{folderId}
  • Auth
    HTTP bearer

Path parameters

folderIdstring uuid required

The UUID of the folder to update. Use the List folders endpoint to retrieve folder IDs.

Request body

namestring

The new display name for the folder. Leading and trailing whitespace is automatically trimmed.

At least one of name or path must be provided.

pathstring

The new URL path segment for the folder, which will automatically be converted to lowercase. When a folder's path is updated, all descendant folder paths are automatically updated.

To be valid, path segments:

  • Can contain only alphanumeric characters and dashes
  • Cannot use reserved names: favorite, labels, move, share, transfer. Folder names may include these words, but the name cannot be only this word. For example, favorite is invalid but my-favorite is not.

At least one of name or path must be provided.

resolvePathConflictboolean

When true, automatically resolves path conflicts by appending a numeric suffix (e.g., blob-sales-2).

When false (default), returns a 409 Conflict error if the path already exists.

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)

Omitting this field leaves the current setting unchanged. Setting it to false or null explicitly clears the breadcrumb root setting.

Example request

{
  "name": "Blob Sales Reports",
  "path": "sales-reports",
  "resolvePathConflict": "true"
}

Response

Folder updated successfully

idstring uuid

Unique identifier for the folder

namestring

Display name of the folder

pathstring

Full path to the folder

breadcrumbRootboolean

Whether breadcrumbs start at this folder

Changes

No recorded changes to this operation across all 2 revisions of this API.