Skip to main content
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>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getquikly.com/llms.txt

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

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Create a new lead session from any client channel.

​
channel
string
required

Client channel: telegram, whatsapp, web, etc.

​
channelId
string
required

Client ID in that channel (chatId, phone, sessionId)

​
callbackUrl
string | null

URL to notify when status changes

​
clientName
string | null
​
clientEmail
string | null
​
brief
string | null
​
discoveryData
Discoverydata · object
​
suggestedProposalType
string | null
​
language
string
default:es
​
providerChatId
string | null

Response

Successful Response