Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
curl --request PATCH \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Blob Sales Reports",
"path": "sales-reports",
"resolvePathConflict": "true"
}
'Update folder
This endpoint requires Editor permissions or higher on the folder being updated.
Update a folder’s name and/or path segment. Either or both fields can be updated in a single request.
curl --request PATCH \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Blob Sales Reports",
"path": "sales-reports",
"resolvePathConflict": "true"
}
'Name-only updates will not trigger updates to descendant folders (subfolders). However, path updates will automatically update all descendent folder paths. Consider the following folder structure:Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
.
└── blob-shared
├── sales # full path: /blob-shared/sales
└── marketing # full path: /blob-shared/marketing
blob-shared is updated to all-blobs, the full paths for its descendent folders will be automatically updated:
.
└── all-blobs
├── sales # full path: /all-blobs/sales
└── marketing # full path: /all-blobs/marketing
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The UUID of the folder to update. Use the List folders endpoint to retrieve folder IDs.
Body
The new display name for the folder. Leading and trailing whitespace is automatically trimmed.
At least one of name or path must be provided.
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,favoriteis invalid butmy-favoriteis not.
At least one of name or path must be provided.
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.
Was this page helpful?