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 DELETE \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId} \
--header 'Authorization: Bearer <token>'{
"success": true
}Delete folder
Delete a folder. By default, only empty folders can be deleted. Use the force parameter to recursively delete folders containing documents and sub-folders.
When force is enabled:
- All documents are archived (soft-delete to trash) across the folder tree
- Subfolders are deleted recursively, starting with the most deeply-nested subfolder and walking up the folder tree
- Up to 100 items (documents and subfolders) can be deleted. If a folder contains more than 100 items, the item will return a
400. No items will be deleted. - All operations occur in a single transaction - partial failures roll back completely
- SSO embed users cannot force-delete entity folders
curl --request DELETE \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId} \
--header 'Authorization: Bearer <token>'{
"success": true
}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.
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 delete. Use the List folders endpoint to retrieve folder IDs.
Query Parameters
When true, recursively archives documents (to trash) and deletes sub-folders. Limited to 100 total items.
Response
Folder deleted successfully
true
Was this page helpful?