Skip to main content
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
messages
Create a new message
curl --request POST \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "conversationId": "<string>",
  "messageBody": "<string>",
  "enableExternalBroadcast": true,
  "replyToMessageId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
  "mediaIds": [
    "<string>"
  ]
}
'
import requests

url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages"

payload = {
"conversationId": "<string>",
"messageBody": "<string>",
"enableExternalBroadcast": True,
"replyToMessageId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"mediaIds": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversationId: '<string>',
messageBody: '<string>',
enableExternalBroadcast: true,
replyToMessageId: 'b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234',
mediaIds: ['<string>']
})
};

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conversationId' => '<string>',
'messageBody' => '<string>',
'enableExternalBroadcast' => true,
'replyToMessageId' => 'b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234',
'mediaIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages"

payload := strings.NewReader("{\n \"conversationId\": \"<string>\",\n \"messageBody\": \"<string>\",\n \"enableExternalBroadcast\": true,\n \"replyToMessageId\": \"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234\",\n \"mediaIds\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"<string>\",\n \"messageBody\": \"<string>\",\n \"enableExternalBroadcast\": true,\n \"replyToMessageId\": \"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234\",\n \"mediaIds\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversationId\": \"<string>\",\n \"messageBody\": \"<string>\",\n \"enableExternalBroadcast\": true,\n \"replyToMessageId\": \"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234\",\n \"mediaIds\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "messageId": "<string>",
  "messagingProduct": "bridge"
}

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Body

application/json

Request body for creating a new message within a specified conversation.

conversationId
string
required

Identifier of the conversation.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

messageBody
string
required

Body of the message.

Example:

"Hello, welcome to Bridge!"

enableExternalBroadcast
boolean
required

Flag to enable external broadcast.

Examples:

true

false

replyToMessageId
string | null

Identifier of the message being replied to.

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

mediaIds
string[]

List of media IDs associated with the message.

Example:
["a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6"]

Response

Successful Response

Response body for message-related operations.

messageId
string
required

Unique message identifier as a UUID string.

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

messagingProduct
string
default:bridge

Product name.

Example:

"bridge"