Initiate a LeadScout outbound conversation with a known lead
curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"contact": {
"identifier": "+573001234567",
"identifierType": "PHONE",
"messageProviderType": "WHATSAPP",
"providerChannelId": "c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c"
},
"template": {
"name": "leadscout_outbound_fb_v1",
"orderedParams": [
"Maria",
"ACME"
],
"parameters": {
"recipient_first_name": "Maria",
"tracking_code": "TRK123"
},
"media": {
"type": "IMAGE",
"mediaId": null,
"url": null
}
},
"additionalMessages": [
{
"messageBody": "Just confirming we're still on for tomorrow at 10am.",
"mediaIds": []
}
],
"agentContext": {
"notes": "Lead asked about pricing tiers last week.",
"mediaIds": []
},
"consent": {
"status": "GRANTED",
"capturedAt": "2026-04-20T10:00:00.000Z"
},
"handoffOverride": {
"preAssignedUser": {
"identifier": "advisor@acme.com",
"identifierType": "EMAIL"
}
},
"brandId": null,
"campaignId": null,
"forceSend": false
}
EOFimport requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound"
payload = {
"contact": {
"identifier": "+573001234567",
"identifierType": "PHONE",
"messageProviderType": "WHATSAPP",
"providerChannelId": "c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c"
},
"template": {
"name": "leadscout_outbound_fb_v1",
"orderedParams": ["Maria", "ACME"],
"parameters": {
"recipient_first_name": "Maria",
"tracking_code": "TRK123"
},
"media": {
"type": "IMAGE",
"mediaId": None,
"url": None
}
},
"additionalMessages": [
{
"messageBody": "Just confirming we're still on for tomorrow at 10am.",
"mediaIds": []
}
],
"agentContext": {
"notes": "Lead asked about pricing tiers last week.",
"mediaIds": []
},
"consent": {
"status": "GRANTED",
"capturedAt": "2026-04-20T10:00:00.000Z"
},
"handoffOverride": { "preAssignedUser": {
"identifier": "advisor@acme.com",
"identifierType": "EMAIL"
} },
"brandId": None,
"campaignId": None,
"forceSend": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
identifier: '+573001234567',
identifierType: 'PHONE',
messageProviderType: 'WHATSAPP',
providerChannelId: 'c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c'
},
template: {
name: 'leadscout_outbound_fb_v1',
orderedParams: ['Maria', 'ACME'],
parameters: {recipient_first_name: 'Maria', tracking_code: 'TRK123'},
media: {type: 'IMAGE', mediaId: null, url: null}
},
additionalMessages: [
{
messageBody: 'Just confirming we\'re still on for tomorrow at 10am.',
mediaIds: []
}
],
agentContext: {notes: 'Lead asked about pricing tiers last week.', mediaIds: []},
consent: {status: 'GRANTED', capturedAt: '2026-04-20T10:00:00.000Z'},
handoffOverride: {preAssignedUser: {identifier: 'advisor@acme.com', identifierType: 'EMAIL'}},
brandId: null,
campaignId: null,
forceSend: false
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound', 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}/leadscout/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact' => [
'identifier' => '+573001234567',
'identifierType' => 'PHONE',
'messageProviderType' => 'WHATSAPP',
'providerChannelId' => 'c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c'
],
'template' => [
'name' => 'leadscout_outbound_fb_v1',
'orderedParams' => [
'Maria',
'ACME'
],
'parameters' => [
'recipient_first_name' => 'Maria',
'tracking_code' => 'TRK123'
],
'media' => [
'type' => 'IMAGE',
'mediaId' => null,
'url' => null
]
],
'additionalMessages' => [
[
'messageBody' => 'Just confirming we\'re still on for tomorrow at 10am.',
'mediaIds' => [
]
]
],
'agentContext' => [
'notes' => 'Lead asked about pricing tiers last week.',
'mediaIds' => [
]
],
'consent' => [
'status' => 'GRANTED',
'capturedAt' => '2026-04-20T10:00:00.000Z'
],
'handoffOverride' => [
'preAssignedUser' => [
'identifier' => 'advisor@acme.com',
'identifierType' => 'EMAIL'
]
],
'brandId' => null,
'campaignId' => null,
'forceSend' => false
]),
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}/leadscout/outbound"
payload := strings.NewReader("{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}"
response = http.request(request)
puts response.read_body{
"conversation": {
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"participants": {
"externals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
],
"internals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
]
},
"createdAt": "2003-04-10T09:00:00.000Z",
"updatedAt": "2003-04-10T09:00:00.000Z",
"name": "Bridge Support Team",
"status": "ACTIVE"
},
"contact": {
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5",
"type": "NORMAL",
"createdAt": "2003-04-10T08:00:00.000Z",
"updatedAt": "2003-04-10T08:00:00.000Z",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"cellphone": "+14084029292",
"customAttributes": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"languageCode": "EN",
"ownerId": "37673840-6259-40f9-bbe5-a7db40f8e3cf"
},
"templateSent": {
"name": "leadscout_outbound_fb_v1",
"messageId": null
},
"additionalMessagesPersisted": 0,
"alreadyInitiated": false
}LeadScout API
Initiate a LeadScout outbound conversation with a known lead
Start an AI-controlled outbound conversation with a known lead.
Pre-flight checks run before any write: template exists and is APPROVED, contact
exists, a WhatsApp channel resolves, a prospection agent owns it, and any
handoffOverride user is valid.
If an active conversation is already running on the chosen channel:
forceSend=false(default) →409with error code BRIDGE_AI_LEADSCOUT_0007.forceSend=true→ that conversation is reused; the new template and follow-ups are appended to it and the response setsalreadyInitiated=true.
Otherwise a fresh conversation is opened (controlled by the prospection agent) with
the template as its first message; additionalMessages are persisted for the agent
to send once the lead replies.
Error codes:
- BRIDGE_AI_LEADSCOUT_0001: external user not found
- BRIDGE_AI_LEADSCOUT_0002: internal user not found
- BRIDGE_AI_LEADSCOUT_0003: internal user deleted
- BRIDGE_AI_LEADSCOUT_0004: template not found
- BRIDGE_AI_LEADSCOUT_0005: template not approved
- BRIDGE_AI_LEADSCOUT_0006: template ordered params mismatch
- BRIDGE_AI_LEADSCOUT_0007: active conversation already exists
- BRIDGE_AI_LEADSCOUT_0008: all provider channels occupied
- BRIDGE_AI_LEADSCOUT_0009: no channels for brand
- BRIDGE_AI_LEADSCOUT_0010: provider channel not in workspace
- BRIDGE_AI_LEADSCOUT_0011: workspace has no provider channels
- BRIDGE_AI_LEADSCOUT_0012: no prospecting agent for channel
- BRIDGE_AI_LEADSCOUT_0013: multiple prospecting agents for brand
- BRIDGE_AI_LEADSCOUT_0014: multiple prospecting agents for channel
- BRIDGE_AI_LEADSCOUT_0015: conversation operation failed
- BRIDGE_AI_LEADSCOUT_0016: outbound validation error
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
leadscout
/
outbound
Initiate a LeadScout outbound conversation with a known lead
curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"contact": {
"identifier": "+573001234567",
"identifierType": "PHONE",
"messageProviderType": "WHATSAPP",
"providerChannelId": "c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c"
},
"template": {
"name": "leadscout_outbound_fb_v1",
"orderedParams": [
"Maria",
"ACME"
],
"parameters": {
"recipient_first_name": "Maria",
"tracking_code": "TRK123"
},
"media": {
"type": "IMAGE",
"mediaId": null,
"url": null
}
},
"additionalMessages": [
{
"messageBody": "Just confirming we're still on for tomorrow at 10am.",
"mediaIds": []
}
],
"agentContext": {
"notes": "Lead asked about pricing tiers last week.",
"mediaIds": []
},
"consent": {
"status": "GRANTED",
"capturedAt": "2026-04-20T10:00:00.000Z"
},
"handoffOverride": {
"preAssignedUser": {
"identifier": "advisor@acme.com",
"identifierType": "EMAIL"
}
},
"brandId": null,
"campaignId": null,
"forceSend": false
}
EOFimport requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound"
payload = {
"contact": {
"identifier": "+573001234567",
"identifierType": "PHONE",
"messageProviderType": "WHATSAPP",
"providerChannelId": "c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c"
},
"template": {
"name": "leadscout_outbound_fb_v1",
"orderedParams": ["Maria", "ACME"],
"parameters": {
"recipient_first_name": "Maria",
"tracking_code": "TRK123"
},
"media": {
"type": "IMAGE",
"mediaId": None,
"url": None
}
},
"additionalMessages": [
{
"messageBody": "Just confirming we're still on for tomorrow at 10am.",
"mediaIds": []
}
],
"agentContext": {
"notes": "Lead asked about pricing tiers last week.",
"mediaIds": []
},
"consent": {
"status": "GRANTED",
"capturedAt": "2026-04-20T10:00:00.000Z"
},
"handoffOverride": { "preAssignedUser": {
"identifier": "advisor@acme.com",
"identifierType": "EMAIL"
} },
"brandId": None,
"campaignId": None,
"forceSend": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
identifier: '+573001234567',
identifierType: 'PHONE',
messageProviderType: 'WHATSAPP',
providerChannelId: 'c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c'
},
template: {
name: 'leadscout_outbound_fb_v1',
orderedParams: ['Maria', 'ACME'],
parameters: {recipient_first_name: 'Maria', tracking_code: 'TRK123'},
media: {type: 'IMAGE', mediaId: null, url: null}
},
additionalMessages: [
{
messageBody: 'Just confirming we\'re still on for tomorrow at 10am.',
mediaIds: []
}
],
agentContext: {notes: 'Lead asked about pricing tiers last week.', mediaIds: []},
consent: {status: 'GRANTED', capturedAt: '2026-04-20T10:00:00.000Z'},
handoffOverride: {preAssignedUser: {identifier: 'advisor@acme.com', identifierType: 'EMAIL'}},
brandId: null,
campaignId: null,
forceSend: false
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound', 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}/leadscout/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact' => [
'identifier' => '+573001234567',
'identifierType' => 'PHONE',
'messageProviderType' => 'WHATSAPP',
'providerChannelId' => 'c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c'
],
'template' => [
'name' => 'leadscout_outbound_fb_v1',
'orderedParams' => [
'Maria',
'ACME'
],
'parameters' => [
'recipient_first_name' => 'Maria',
'tracking_code' => 'TRK123'
],
'media' => [
'type' => 'IMAGE',
'mediaId' => null,
'url' => null
]
],
'additionalMessages' => [
[
'messageBody' => 'Just confirming we\'re still on for tomorrow at 10am.',
'mediaIds' => [
]
]
],
'agentContext' => [
'notes' => 'Lead asked about pricing tiers last week.',
'mediaIds' => [
]
],
'consent' => [
'status' => 'GRANTED',
'capturedAt' => '2026-04-20T10:00:00.000Z'
],
'handoffOverride' => [
'preAssignedUser' => [
'identifier' => 'advisor@acme.com',
'identifierType' => 'EMAIL'
]
],
'brandId' => null,
'campaignId' => null,
'forceSend' => false
]),
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}/leadscout/outbound"
payload := strings.NewReader("{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"identifier\": \"+573001234567\",\n \"identifierType\": \"PHONE\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c\"\n },\n \"template\": {\n \"name\": \"leadscout_outbound_fb_v1\",\n \"orderedParams\": [\n \"Maria\",\n \"ACME\"\n ],\n \"parameters\": {\n \"recipient_first_name\": \"Maria\",\n \"tracking_code\": \"TRK123\"\n },\n \"media\": {\n \"type\": \"IMAGE\",\n \"mediaId\": null,\n \"url\": null\n }\n },\n \"additionalMessages\": [\n {\n \"messageBody\": \"Just confirming we're still on for tomorrow at 10am.\",\n \"mediaIds\": []\n }\n ],\n \"agentContext\": {\n \"notes\": \"Lead asked about pricing tiers last week.\",\n \"mediaIds\": []\n },\n \"consent\": {\n \"status\": \"GRANTED\",\n \"capturedAt\": \"2026-04-20T10:00:00.000Z\"\n },\n \"handoffOverride\": {\n \"preAssignedUser\": {\n \"identifier\": \"advisor@acme.com\",\n \"identifierType\": \"EMAIL\"\n }\n },\n \"brandId\": null,\n \"campaignId\": null,\n \"forceSend\": false\n}"
response = http.request(request)
puts response.read_body{
"conversation": {
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"participants": {
"externals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
],
"internals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
]
},
"createdAt": "2003-04-10T09:00:00.000Z",
"updatedAt": "2003-04-10T09:00:00.000Z",
"name": "Bridge Support Team",
"status": "ACTIVE"
},
"contact": {
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5",
"type": "NORMAL",
"createdAt": "2003-04-10T08:00:00.000Z",
"updatedAt": "2003-04-10T08:00:00.000Z",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"cellphone": "+14084029292",
"customAttributes": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"languageCode": "EN",
"ownerId": "37673840-6259-40f9-bbe5-a7db40f8e3cf"
},
"templateSent": {
"name": "leadscout_outbound_fb_v1",
"messageId": null
},
"additionalMessagesPersisted": 0,
"alreadyInitiated": false
}Authorizations
Copy the API key as provided by the Bridge Console.
Path Parameters
Unique identifier of the workspace (UUID v4).
Example:
"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"
Body
application/json
Request body for initiating a LeadScout outbound conversation.
The lead this outbound conversation targets. Must already exist in the workspace.
Show child attributes
Show child attributes
The opening template to send.
Show child attributes
Show child attributes
Up to five follow-up messages persisted on the conversation. They are not delivered immediately; the agent decides when to send them once the lead replies.
Maximum array length:
5Show child attributes
Show child attributes
Notes and media stored on the conversation as agent context for the AI / human reviewer.
Show child attributes
Show child attributes
Tenant-affirmed opt-in evidence recorded verbatim on the conversation.
Show child attributes
Show child attributes
Overrides the default advisor assignment for the outbound conversation.
Show child attributes
Show child attributes
Optional brand id. When provided, only channels linked to this brand are eligible. Omit to consider every channel in the workspace.
Example:
null
Optional campaign reference stored on the conversation for audit and reporting.
Example:
null
When true, bypass all blockers on the chosen channel: any active conversation (AI-prospecting or human) is ignored and a fresh outbound is created. When no providerChannelId is supplied and every workspace channel is occupied, the first candidate is used instead of raising AllProviderChannelsOccupied. When false (default), an existing active conversation on the chosen channel returns 409.
Examples:
false
true
Response
Successful Response
Response body for a successful LeadScout outbound initiation.
The newly created AI-controlled conversation.
Show child attributes
Show child attributes
The contact the conversation was initiated with.
Show child attributes
Show child attributes
Summary of the template dispatched to open the conversation.
Show child attributes
Show child attributes
Count of follow-up messages persisted on the conversation.
Examples:
0
3
True when this request landed on a pre-existing conversation (forceSend=true reuse path); false when a fresh conversation was created. Informational only — the new template and follow-ups are persisted either way.
Examples:
false
true
Was this page helpful?