Skip to main content
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 '
{
  "contact": {
    "identifier": "<string>",
    "identifierType": "<string>",
    "messageProviderType": "<string>",
    "providerChannelId": "a3a3a3a3-3a3a-3a3a-3a3a-3a3a3a3a3a3a"
  },
  "template": {
    "name": "<string>",
    "orderedParams": [
      "<string>"
    ]
  },
  "handoffOverride": {
    "preAssignedUser": {
      "identifier": "<string>",
      "identifierType": "ID"
    }
  }
}
'
{ "conversation": { "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" }, "contact": { "id": "<string>", "workspaceId": "<string>", "type": "PARTIAL", "createdAt": "<string>", "updatedAt": "<string>", "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": "<string>", "messageId": null }, "alreadyInitiated": false }

Documentation Index

Fetch the complete documentation index at: https://docs.bridge.new/llms.txt

Use this file to discover all available pages before exploring further.

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 initiating a LeadScout outbound conversation.

​
contact
Contact · object
required

The lead this outbound conversation targets. Must already exist in the workspace.

​
template
Template · object
required

The opening template to send.

​
handoffOverride
LeadscoutOutboundHandoffOverride · object

Overrides the default advisor assignment for the outbound conversation.

Response

Successful Response

Response body for a successful LeadScout outbound initiation.

​
conversation
Conversation · object
required

The newly created AI-controlled conversation.

​
contact
Contact · object
required

The contact the conversation was initiated with.

​
templateSent
Template Sent · object
required

Summary of the dispatched template.

​
alreadyInitiated
boolean
default:false

True if the outbound was previously initiated for this contact + channel. Always false on the happy-path goal.

Example:

false