POST
Messages.MarkRead
Mark one or more message rows as read.
Permissions
- User must be logged in with a valid bearer token.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Updates the requested Messages record after validating permissions and input fields.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- Send parameters as POST body fields exactly as documented.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
message_idpost | int | 101 | Single message id. |
id_arraypost | array|string | 101,102 | Multiple message ids. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Messages.MarkRead",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"id_array": "101,102"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Messages.MarkRead",
"url_domain": "https:\/\/{domain}\/app\/Messages.MarkRead"
}Endpoint
POST /app/Messages.MarkRead
POST https://{user}.bull36.com/app/Messages.MarkRead
POST https://{domain}/app/Messages.MarkReadSample Output
{
"success": 1,
"message": "Messages marked read"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ id_array: '101,102' });
const res = await fetch('/app/Messages.MarkRead', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();Error Example
{
"success": "0",
"message": "Missing required parameter: message_id or id_array"
}