POST
Files.Remove
Alias of Files.Delete. Remove one customer file, run files.deleted automation, and emit realtime files.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 Files record when the user has permission.
Push Service
Pushes event files.deleted to users who should see this change.
Automation
Runs automation event files.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 |
|---|---|---|---|
customer_idpost | int | 123 | Customer id that owns the file. |
file_idpost | int | 456 | File id. You may also send id. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
file_namepost | string | Signed contract | User-facing display name when editing a file. |
folderpost | string | contracts | File folder/type when editing a file. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Files.Remove",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"customer_id": "123",
"file_id": "456"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Files.Remove",
"url_domain": "https:\/\/{domain}\/app\/Files.Remove"
}Endpoint
POST /app/Files.Remove
POST https://{user}.bull36.com/app/Files.Remove
POST https://{domain}/app/Files.RemoveSample Output
{
"success": 1,
"message": "File removed",
"file_id": "456",
"customer_id": "123",
"automation_event": "files.deleted",
"socket_event": "files.deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '123');
body.set('file_id', '456');
const res = await fetch('/app/Files.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Missing required parameter: customer_id, file_id"
}