POST

Support.Messages

Read a paged SUPPORT conversation, newest message first. Customers can read customer-visible messages only; internal notes require support staff. Reading does not change read receipts.

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

  • Runs the Support.Messages function and returns JSON.

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

NameTypeSampleExplanation
ticket_id
post
int123Support ticket id. Access is restricted to the signed-in organization or support staff.

Optional Parameters

NameTypeSampleWhat it gives
start
post
int0Zero-based row offset. Default 0.
limit
post
int25Page size, default and maximum 25. Must be positive.
visibility
post
stringcustomerall (default), customer, or internal. Non-support users always receive customer-visible messages; explicit internal access returns 403.

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\/Support.Messages",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN",
        "Content-Type": "application\/json"
    },
    "body": {
        "ticket_id": "123",
        "visibility": "customer",
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Support.Messages",
    "url_domain": "https:\/\/{domain}\/app\/Support.Messages"
}

Endpoint

POST /app/Support.Messages
POST https://{user}.bull36.com/app/Support.Messages
POST https://{domain}/app/Support.Messages

Sample Output

{
    "success": 1,
    "data": [
        {
            "id": 12,
            "ticket_id": 123,
            "type": "chat",
            "message": "We are checking"
        }
    ],
    "total": 1,
    "count": 1,
    "start": 0,
    "limit": 25
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Support.Messages",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Support.Messages",
    "url_domain": "https:\/\/{domain}\/app\/Support.Messages",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "ticket_id": "123",
        "visibility": "customer"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "total": "total is all matching accessible rows; count is the number of rows on this page."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('ticket_id', '123');
body.set('visibility', 'customer');

const res = await fetch('https://{domain}/app/Support.Messages', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = {
  "ticket_id": "123",
  "visibility": "customer",
  "limit": "25"
};

const res = await fetch('/app/Support.Messages', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify(body)
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}