POST

FileFolders.Delete

Delete a customer file folder. When deleting a parent folder, its sub-folders are also removed. The directdelete.deleted automation and emits realtime filefolders.delete.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.delete.deleted to users who should see this change.

Automation

Runs automation event filefolders.delete.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

NameTypeSampleExplanation
folder_id
post
int12Folder or sub-folder id to delete. You may also send data_id.

Optional Parameters

NameTypeSampleWhat it gives
thisIsSub
post
int1Set 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.Delete",
    "method": "POST",
    "body": {
        "folder_id": "12"
    },
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/FileFolders.Delete",
    "url_domain": "https:\/\/{domain}\/app\/FileFolders.Delete"
}

Endpoint

POST /app/FileFolders.Delete
POST https://{user}.bull36.com/app/FileFolders.Delete
POST https://{domain}/app/FileFolders.Delete

Sample Output

{
    "success": 1,
    "message": "Success",
    "automation_event": "filefolders.delete.deleted",
    "socket_event": "filefolders.delete.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.Delete', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Failed"
}