Skip to main content
POST
Create Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agentId
string
required
prospect_id
string | null

Body

application/json
sourceId
string
required

Unique identifier for the source

Required string length: 1 - 512
Example:

"id_123"

sourceProps
Sourceprops · object
required

Extra properties of source

Example:

"Browser"

sourceName
enum<string>
default:BROWSER

Name of the source

Available options:
TWILIO,
PLIVO,
BROWSER
Required string length: 1 - 512
Example:

"TWILIO"

Response

Successful Response

This represents the connection between the user and the assistant

id
string
orgId
string
sourceName
string
sourceId
string
sourceProps
Sourceprops · object | null
agentId
string
prospectId
string | null
createdBy
string
createdAt
string<date-time>
updatedBy
string
updatedAt
string<date-time>