Skip to content
ChatVendor ChatVendor

Messenger API

Everything the panel can do with a connected Telegram, WhatsApp or Instagram account, over REST — one key, one response shape, chapter by chapter.

Leads

Leads captured by rules and AI, with status, score, tags and summary.

Leads are created by lead rules and the AI; account_id is the Telegram channel id, peer_id the customer.

Base URL: https://chatvendor.net/api/v1 · every response is {"success": true, "data": …}

GET /leads List leads

Scope: leads:read

Parameters

statusquery · string
qquery · string

Response 200 · Lead[]

id integeraccount_id integerpeer_id integertitle stringusername stringphone stringstatus stringscore integertags string[]summary stringdata objectlast_message_at string (date-time)

curl https://chatvendor.net/api/v1/leads \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"
POST /leads Create a lead (account_id may be a channel reference such as wa_12); amount = deal value for the pipeline

Scope: leads:write

Body (application/json)

account_idstringrequired
peer_idintegerrequired
amountnumber
sourcestring
titlestring
statusstring
tagsstring[]
scoreinteger
notesstring

Response 200 · Lead

id integeraccount_id integerpeer_id integertitle stringusername stringphone stringstatus stringscore integertags string[]summary stringdata objectlast_message_at string (date-time)

curl -X POST https://chatvendor.net/api/v1/leads \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"
  -H "Content-Type: application/json" \
  -d '{"account_id":"…","peer_id":1}'
GET /leads/{leadId} One lead

Scope: leads:read

Parameters

leadIdpath · integerrequired

Lead id

Response 200 · Lead

id integeraccount_id integerpeer_id integertitle stringusername stringphone stringstatus stringscore integertags string[]summary stringdata objectlast_message_at string (date-time)

curl https://chatvendor.net/api/v1/leads/42 \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"
PATCH /leads/{leadId} Update a lead

Scope: leads:write

Parameters

leadIdpath · integerrequired

Lead id

Response 200 · Lead

id integeraccount_id integerpeer_id integertitle stringusername stringphone stringstatus stringscore integertags string[]summary stringdata objectlast_message_at string (date-time)

curl -X PATCH https://chatvendor.net/api/v1/leads/42 \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"
DELETE /leads/{leadId} Delete a lead

Scope: leads:write

Parameters

leadIdpath · integerrequired

Lead id

Response 200

OK

curl -X DELETE https://chatvendor.net/api/v1/leads/42 \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"