POST

Documents.Delete

Delete one uploaded customer file/document from client_file when the active user has permission. This removes the database row, does not delete the physical file from the files server, and publishes documents.deleted automation and realtime events.

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 Documents record when the user has permission.

Push Service

Pushes event documents.deleted to users who should see this change.

Automation

Runs automation event documents.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
document_id
post
int456Uploaded customer file/document id from client_file. You may also send file_id or 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\/Documents.Delete",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "document_id": "456"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Documents.Delete",
    "url_domain": "https:\/\/{domain}\/app\/Documents.Delete"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "output": "1",
    "message": "Your File Remove",
    "document_id": 456,
    "file_id": 456,
    "automation_event": "documents.deleted",
    "socket_event": "documents.deleted"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ document_id: '456' });

const res = await fetch('/app/Documents.Delete', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + token },
  body
});

const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "output": 0,
    "message": "permission denied"
}