Skip to main content
PATCH
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
conversations
/
{conversationId}
Update conversation
curl --request PATCH \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Client Support",
  "status": "ACTIVE",
  "participants": {
    "externals": {
      "add": [
        {
          "identifier": "<string>",
          "identifierType": "ID",
          "messageProviderType": "WHATSAPP",
          "providerChannelId": "<string>"
        }
      ],
      "remove": [
        {
          "identifier": "<string>",
          "identifierType": "ID",
          "messageProviderType": "WHATSAPP",
          "providerChannelId": "<string>"
        }
      ]
    },
    "internals": {
      "add": [
        {
          "identifier": "<string>",
          "identifierType": "ID"
        }
      ],
      "remove": [
        {
          "identifier": "<string>",
          "identifierType": "ID"
        }
      ]
    }
  }
}
'
{ "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"

​
conversationId
string<uuid>
required

Unique identifier of the conversation (UUID v4).

Example:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Body

application/json

Request body for updating an existing conversation.

​
name
string | null

Optional name/title for the conversation.

Example:

"Client Support"

​
status
enum<string> | null

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"

​
participants
ParticipantOperationsRequest · object

Request body for participant operations when updating a conversation.

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"