Skip to main content
PATCH
/
v1
/
folders
/
{folderId}
Update folder
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"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Blob Sales Reports",
  "path": "sales-reports"
}
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:
Existing paths with /blob-shared
.
└── blob-shared
    ├── sales      # full path: /blob-shared/sales
    └── marketing  # full path: /blob-shared/marketing
If the path for blob-shared is updated to all-blobs, the full paths for its descendent folders will be automatically updated:
New paths with /all-blobs
.
└── all-blobs
    ├── sales       # full path: /all-blobs/sales
    └── marketing   # full path: /all-blobs/marketing

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

Path Parameters

​
folderId
string<uuid>
required

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

Body

application/json
​
name
string

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

At least one of name or path must be provided.

​
path
string

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.

​
resolvePathConflict
boolean
default:false

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.

Response

Folder updated successfully

​
id
string<uuid>

Unique identifier for the folder

​
name
string

Display name of the folder

​
path
string

Full path to the folder