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>",
          "messageProviderType": "WHATSAPP",
          "providerChannelId": "<string>"
        }
      ],
      "remove": [
        {
          "identifier": "<string>",
          "messageProviderType": "WHATSAPP",
          "providerChannelId": "<string>"
        }
      ]
    },
    "internals": {
      "add": [
        {
          "identifier": "<string>"
        }
      ],
      "remove": [
        {
          "identifier": "<string>"
        }
      ]
    }
  }
}
'
import requests

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

payload = {
    "name": "Client Support",
    "status": "ACTIVE",
    "participants": {
        "externals": {
            "add": [
                {
                    "identifier": "<string>",
                    "messageProviderType": "WHATSAPP",
                    "providerChannelId": "<string>"
                }
            ],
            "remove": [
                {
                    "identifier": "<string>",
                    "messageProviderType": "WHATSAPP",
                    "providerChannelId": "<string>"
                }
            ]
        },
        "internals": {
            "add": [{ "identifier": "<string>" }],
            "remove": [{ "identifier": "<string>" }]
        }
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Client Support',
    status: 'ACTIVE',
    participants: {
      externals: {
        add: [
          {
            identifier: '<string>',
            messageProviderType: 'WHATSAPP',
            providerChannelId: '<string>'
          }
        ],
        remove: [
          {
            identifier: '<string>',
            messageProviderType: 'WHATSAPP',
            providerChannelId: '<string>'
          }
        ]
      },
      internals: {add: [{identifier: '<string>'}], remove: [{identifier: '<string>'}]}
    }
  })
};

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}', 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}/conversations/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Client Support',
    'status' => 'ACTIVE',
    'participants' => [
        'externals' => [
                'add' => [
                                [
                                                                'identifier' => '<string>',
                                                                'messageProviderType' => 'WHATSAPP',
                                                                'providerChannelId' => '<string>'
                                ]
                ],
                'remove' => [
                                [
                                                                'identifier' => '<string>',
                                                                'messageProviderType' => 'WHATSAPP',
                                                                'providerChannelId' => '<string>'
                                ]
                ]
        ],
        'internals' => [
                'add' => [
                                [
                                                                'identifier' => '<string>'
                                ]
                ],
                'remove' => [
                                [
                                                                'identifier' => '<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}/conversations/{conversationId}"

	payload := strings.NewReader("{\n  \"name\": \"Client Support\",\n  \"status\": \"ACTIVE\",\n  \"participants\": {\n    \"externals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ]\n    },\n    \"internals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Client Support\",\n  \"status\": \"ACTIVE\",\n  \"participants\": {\n    \"externals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ]\n    },\n    \"internals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Client Support\",\n  \"status\": \"ACTIVE\",\n  \"participants\": {\n    \"externals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\",\n          \"messageProviderType\": \"WHATSAPP\",\n          \"providerChannelId\": \"<string>\"\n        }\n      ]\n    },\n    \"internals\": {\n      \"add\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ],\n      \"remove\": [\n        {\n          \"identifier\": \"<string>\"\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "workspaceId": "<string>",
  "participants": {
    "externals": [
      {
        "identifier": "<string>",
        "joinedAt": "2023-11-07T05:31:56Z",
        "lastSeenAt": null
      }
    ],
    "internals": [
      {
        "identifier": "<string>",
        "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 | null

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"