POST
Messages.Delete
Move a message to trash. Permanent delete requires manager permission and confirm_delete_forever=1. The directdeleted automation and emits realtime message.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 Messages record when the user has permission.
Push Service
Pushes event message.deleted to users who should see this change.
Automation
Runs automation event message.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 |
|---|---|---|---|
message_idpost | int | 101 | Message id to delete. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
confirm_delete_foreverpost | int | 1 | Required only when permanently deleting from trash. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Messages.Delete",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"message_id": "101"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Messages.Delete",
"url_domain": "https:\/\/{domain}\/app\/Messages.Delete"
}Endpoint
POST /app/Messages.Delete
POST https://{user}.bull36.com/app/Messages.Delete
POST https://{domain}/app/Messages.DeleteSample Output
{
"success": 1,
"message": "Message moved to trash",
"automation_event": "message.deleted",
"socket_event": "message.deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ message_id: '101' });
const res = await fetch('/app/Messages.Delete', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();Error Example
{
"success": "0",
"message": "Missing required parameter: message_id"
}