Skip to main content
POST
Create a new message

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:

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"