Delete a folder
folder-deleteDelete a Foundry VTT sidebar folder by ID or exact name, optionally removing its documents and subfolders. Requires folder and document delete permissions.
Instructions
Delete a sidebar folder, found by its id or exact name. By default its documents and subfolders move up one level. With deleteContents true, all documents and subfolders inside are deleted as well. Needs the folder permission level "create, change and delete", and for deleteContents the same level for the documents inside.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"folderName": "<folderName>"
},
"name": "folder-delete"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Document type of the folder, e.g. "JournalEntry". | |
| folderName | Yes | Id or exact name of the folder. | |
| deleteContents | No | Also delete everything inside, subfolders included (default false). |