POST

Messages.Forward

Save a forwarded copy of an existing message when forward is allowed. After a successful forward the route runs message.forwarded automation and emits realtime message.forwarded.

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

  • Updates the requested Messages record after validating permissions and input fields.

Push Service

Pushes event message.forwarded to users who should see this change.

Automation

Runs automation event message.forwarded 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
message_id
post
int101Message being forwarded.
to
post
string[email protected]Forward recipient.

Optional Parameters

NameTypeSampleWhat it gives
message
post
stringFYIOptional forward note.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Messages.Forward",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "message_id": "101",
        "to": "[email protected]"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Messages.Forward",
    "url_domain": "https:\/\/{domain}\/app\/Messages.Forward"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message_id": "103",
    "forwarded_from": "101",
    "automation_event": "message.forwarded",
    "socket_event": "message.forwarded"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ message_id: '101', to: '[email protected]' });
const res = await fetch('/app/Messages.Forward', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();

Error Example

{
    "success": "0",
    "message": "Missing required parameter: to"
}