POST
FileFolders.Remove
Delete a customer file folder. When deleting a parent folder, its sub-folders are also removed. The directremove.deleted automation and emits realtime filefolders.remove.deleted.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Removes the requested FileFolders record when the user has permission.
Push Service
Pushes event filefolders.remove.deleted to users who should see this change.
Automation
Runs automation event filefolders.remove.deleted with the record id and submitted parameters after the action succeeds.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
folder_idpost | int | 12 | Folder or sub-folder id to delete. You may also send data_id. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
thisIsSubpost | int | 1 | Set to 1 when deleting only a sub-folder so child cleanup is skipped. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/FileFolders.Remove",
"method": "POST",
"body": {
"folder_id": "12"
},
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/FileFolders.Remove",
"url_domain": "https:\/\/{domain}\/app\/FileFolders.Remove"
}Endpoint
POST /app/FileFolders.Remove
POST https://{user}.bull36.com/app/FileFolders.Remove
POST https://{domain}/app/FileFolders.RemoveSample Output
{
"success": 1,
"message": "Success",
"automation_event": "filefolders.remove.deleted",
"socket_event": "filefolders.remove.deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/FileFolders.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Failed"
}