Create Lead Session
curl --request POST \
--url https://api.example.com/lead-sessions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"channel": "<string>",
"channelId": "<string>",
"callbackUrl": "<string>",
"clientName": "<string>",
"clientEmail": "<string>",
"brief": "<string>",
"discoveryData": {},
"suggestedProposalType": "<string>",
"language": "es",
"providerChatId": "<string>"
}
'import requests
url = "https://api.example.com/lead-sessions"
payload = {
"channel": "<string>",
"channelId": "<string>",
"callbackUrl": "<string>",
"clientName": "<string>",
"clientEmail": "<string>",
"brief": "<string>",
"discoveryData": {},
"suggestedProposalType": "<string>",
"language": "es",
"providerChatId": "<string>"
}
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({
channel: '<string>',
channelId: '<string>',
callbackUrl: '<string>',
clientName: '<string>',
clientEmail: '<string>',
brief: '<string>',
discoveryData: {},
suggestedProposalType: '<string>',
language: 'es',
providerChatId: '<string>'
})
};
fetch('https://api.example.com/lead-sessions', 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.example.com/lead-sessions",
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([
'channel' => '<string>',
'channelId' => '<string>',
'callbackUrl' => '<string>',
'clientName' => '<string>',
'clientEmail' => '<string>',
'brief' => '<string>',
'discoveryData' => [
],
'suggestedProposalType' => '<string>',
'language' => 'es',
'providerChatId' => '<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.example.com/lead-sessions"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\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.example.com/lead-sessions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/lead-sessions")
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 \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Lead Sessions
Create Lead Session
Create a lead session for a new client inquiry.
Required scope: write
Call this when a client contacts the provider through any channel. The session tracks the discovery state and links the client channel to the provider’s Agent Mode conversation.
Set callbackUrl to receive a POST when the session status changes
(e.g. when the provider marks the proposal as ready).
POST
/
lead-sessions
Create Lead Session
curl --request POST \
--url https://api.example.com/lead-sessions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"channel": "<string>",
"channelId": "<string>",
"callbackUrl": "<string>",
"clientName": "<string>",
"clientEmail": "<string>",
"brief": "<string>",
"discoveryData": {},
"suggestedProposalType": "<string>",
"language": "es",
"providerChatId": "<string>"
}
'import requests
url = "https://api.example.com/lead-sessions"
payload = {
"channel": "<string>",
"channelId": "<string>",
"callbackUrl": "<string>",
"clientName": "<string>",
"clientEmail": "<string>",
"brief": "<string>",
"discoveryData": {},
"suggestedProposalType": "<string>",
"language": "es",
"providerChatId": "<string>"
}
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({
channel: '<string>',
channelId: '<string>',
callbackUrl: '<string>',
clientName: '<string>',
clientEmail: '<string>',
brief: '<string>',
discoveryData: {},
suggestedProposalType: '<string>',
language: 'es',
providerChatId: '<string>'
})
};
fetch('https://api.example.com/lead-sessions', 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.example.com/lead-sessions",
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([
'channel' => '<string>',
'channelId' => '<string>',
'callbackUrl' => '<string>',
'clientName' => '<string>',
'clientEmail' => '<string>',
'brief' => '<string>',
'discoveryData' => [
],
'suggestedProposalType' => '<string>',
'language' => 'es',
'providerChatId' => '<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.example.com/lead-sessions"
payload := strings.NewReader("{\n \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\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.example.com/lead-sessions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/lead-sessions")
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 \"channel\": \"<string>\",\n \"channelId\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"clientName\": \"<string>\",\n \"clientEmail\": \"<string>\",\n \"brief\": \"<string>\",\n \"discoveryData\": {},\n \"suggestedProposalType\": \"<string>\",\n \"language\": \"es\",\n \"providerChatId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Create a new lead session from any client channel.
Client channel: telegram, whatsapp, web, etc.
Client ID in that channel (chatId, phone, sessionId)
URL to notify when status changes
Response
Successful Response
⌘I