Skip to main content
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
conversations
Creates a new conversation with flexible user identification.
curl --request POST \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "participants": {
    "externals": [
      {
        "identifier": "<string>",
        "identifierType": "ID",
        "messageProviderType": "WHATSAPP",
        "providerChannelId": "<string>"
      }
    ],
    "internals": [
      {
        "identifier": "<string>",
        "identifierType": "ID"
      }
    ]
  },
  "name": "Bridge Support Team",
  "status": "ACTIVE",
  "teamId": "9fd1468d-e5ca-4ba3-98d1-13017e6f3808"
}
'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "participants": {
    "externals": [
      {
        "identifier": "<string>",
        "identifierType": "ID",
        "role": "INTERNAL",
        "joinedAt": "2023-11-07T05:31:56Z",
        "lastSeenAt": null
      }
    ],
    "internals": [
      {
        "identifier": "<string>",
        "identifierType": "ID",
        "role": "INTERNAL",
        "joinedAt": "2023-11-07T05:31:56Z",
        "lastSeenAt": null
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "name": "Bridge Support Team",
  "status": "ACTIVE"
}

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 conversation.

​
participants
Participants · object
required

Participants to add to conversation.

​
name
string | null

Optional name/title for the conversation.

Example:

"Bridge Support Team"

​
status
enum<string>
default:ACTIVE

Initial conversation status - 'active' for visible conversations, 'ghost' for invisible until first interaction.

Available options:
ACTIVE,
GHOST,
RELEASED,
NOT_ASSIGNED_TO_HUMAN,
BLOCKED
Example:

"ACTIVE"

​
teamId
string<uuid> | null

Team UUID for round-robin assignment (optional, mutually exclusive with internalParticipants).

Example:

"9fd1468d-e5ca-4ba3-98d1-13017e6f3808"

Response

Successful Response

Response body for conversation details.

​
id
string
required

Unique identifier of the conversation (UUID v4).

Example:

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

​
workspaceId
string
required

Unique identifier of the workspace (UUID v4).

Example:

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

​
participants
Participants · object
required

Participants of the conversation.

​
createdAt
string<date-time>
required

Timestamp when the conversation was created.

Example:

"2003-04-10T09:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the conversation was last updated.

Example:

"2003-04-10T09:00:00.000Z"

​
name
string | null

Optional name/title for the conversation.

Example:

"Bridge Support Team"

​
status
enum<string> | null

Current conversation status - 'ACTIVE' for visible conversations, 'GHOST' for invisible until first interaction.

Available options:
ACTIVE,
GHOST,
RELEASED,
NOT_ASSIGNED_TO_HUMAN,
BLOCKED
Example:

"ACTIVE"