POST
Folders.Remove
Alias of Folders.Delete. Remove a customer folder/status group with automation and realtime refresh.
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 Folders record when the user has permission.
Push Service
Pushes event folders.remove.deleted to users who should see this change.
Automation
Runs automation event folders.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 | 123 | Folder id. |
Optional Parameters
No optional body parameters are defined for this function.
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Folders.Remove",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"folder_id": "123"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Folders.Remove",
"url_domain": "https:\/\/{domain}\/app\/Folders.Remove"
}Endpoint
POST /app/Folders.Remove
POST https://{user}.bull36.com/app/Folders.Remove
POST https://{domain}/app/Folders.RemoveSample Output
{
"success": 1,
"message": "Folders.Remove removed",
"id": "123",
"automation_event": "folders.remove.deleted",
"socket_event": "folders.remove.deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('folder_id', '123');
const res = await fetch('/app/Folders.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Missing required parameter: folder_id"
}