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>"
  ]
}
'
{
  "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"