Edits lead information
curl --request POST \
--url https://api.wppfy.com/chat/editLead \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "5511999999999@s.whatsapp.net",
"chatbot_disableUntil": -1,
"chatbot_agentResetMemoryAt": -1,
"lead_isTicketOpen": true,
"lead_assignedAttendant_id": "att_123456",
"lead_kanbanOrder": 1000,
"lead_tags": [
"vip",
"suporte",
"prioridade-alta"
],
"lead_name": "John Doe",
"lead_fullName": "John Smith Doe",
"lead_email": "joao@exemplo.com",
"lead_personalid": "123.456.789-00",
"lead_status": "qualificado",
"lead_notes": "Customer interested in premium plan",
"lead_field01": "<string>",
"lead_field02": "<string>",
"lead_field03": "<string>",
"lead_field04": "<string>",
"lead_field05": "<string>",
"lead_field06": "<string>",
"lead_field07": "<string>",
"lead_field08": "<string>",
"lead_field09": "<string>",
"lead_field10": "<string>",
"lead_field11": "<string>",
"lead_field12": "<string>",
"lead_field13": "<string>",
"lead_field14": "<string>",
"lead_field15": "<string>",
"lead_field16": "<string>",
"lead_field17": "<string>",
"lead_field18": "<string>",
"lead_field19": "<string>",
"lead_field20": "<string>"
}
'import requests
url = "https://api.wppfy.com/chat/editLead"
payload = {
"id": "5511999999999@s.whatsapp.net",
"chatbot_disableUntil": -1,
"chatbot_agentResetMemoryAt": -1,
"lead_isTicketOpen": True,
"lead_assignedAttendant_id": "att_123456",
"lead_kanbanOrder": 1000,
"lead_tags": ["vip", "suporte", "prioridade-alta"],
"lead_name": "John Doe",
"lead_fullName": "John Smith Doe",
"lead_email": "joao@exemplo.com",
"lead_personalid": "123.456.789-00",
"lead_status": "qualificado",
"lead_notes": "Customer interested in premium plan",
"lead_field01": "<string>",
"lead_field02": "<string>",
"lead_field03": "<string>",
"lead_field04": "<string>",
"lead_field05": "<string>",
"lead_field06": "<string>",
"lead_field07": "<string>",
"lead_field08": "<string>",
"lead_field09": "<string>",
"lead_field10": "<string>",
"lead_field11": "<string>",
"lead_field12": "<string>",
"lead_field13": "<string>",
"lead_field14": "<string>",
"lead_field15": "<string>",
"lead_field16": "<string>",
"lead_field17": "<string>",
"lead_field18": "<string>",
"lead_field19": "<string>",
"lead_field20": "<string>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '5511999999999@s.whatsapp.net',
chatbot_disableUntil: -1,
chatbot_agentResetMemoryAt: -1,
lead_isTicketOpen: true,
lead_assignedAttendant_id: 'att_123456',
lead_kanbanOrder: 1000,
lead_tags: ['vip', 'suporte', 'prioridade-alta'],
lead_name: 'John Doe',
lead_fullName: 'John Smith Doe',
lead_email: 'joao@exemplo.com',
lead_personalid: '123.456.789-00',
lead_status: 'qualificado',
lead_notes: 'Customer interested in premium plan',
lead_field01: '<string>',
lead_field02: '<string>',
lead_field03: '<string>',
lead_field04: '<string>',
lead_field05: '<string>',
lead_field06: '<string>',
lead_field07: '<string>',
lead_field08: '<string>',
lead_field09: '<string>',
lead_field10: '<string>',
lead_field11: '<string>',
lead_field12: '<string>',
lead_field13: '<string>',
lead_field14: '<string>',
lead_field15: '<string>',
lead_field16: '<string>',
lead_field17: '<string>',
lead_field18: '<string>',
lead_field19: '<string>',
lead_field20: '<string>'
})
};
fetch('https://api.wppfy.com/chat/editLead', 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.wppfy.com/chat/editLead",
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([
'id' => '5511999999999@s.whatsapp.net',
'chatbot_disableUntil' => -1,
'chatbot_agentResetMemoryAt' => -1,
'lead_isTicketOpen' => true,
'lead_assignedAttendant_id' => 'att_123456',
'lead_kanbanOrder' => 1000,
'lead_tags' => [
'vip',
'suporte',
'prioridade-alta'
],
'lead_name' => 'John Doe',
'lead_fullName' => 'John Smith Doe',
'lead_email' => 'joao@exemplo.com',
'lead_personalid' => '123.456.789-00',
'lead_status' => 'qualificado',
'lead_notes' => 'Customer interested in premium plan',
'lead_field01' => '<string>',
'lead_field02' => '<string>',
'lead_field03' => '<string>',
'lead_field04' => '<string>',
'lead_field05' => '<string>',
'lead_field06' => '<string>',
'lead_field07' => '<string>',
'lead_field08' => '<string>',
'lead_field09' => '<string>',
'lead_field10' => '<string>',
'lead_field11' => '<string>',
'lead_field12' => '<string>',
'lead_field13' => '<string>',
'lead_field14' => '<string>',
'lead_field15' => '<string>',
'lead_field16' => '<string>',
'lead_field17' => '<string>',
'lead_field18' => '<string>',
'lead_field19' => '<string>',
'lead_field20' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <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.wppfy.com/chat/editLead"
payload := strings.NewReader("{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<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.wppfy.com/chat/editLead")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/chat/editLead")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"wa_fastid": "5511888888888:5511999999999",
"wa_chatid": "5511999999999@s.whatsapp.net",
"lead_name": "João Silva",
"lead_status": "qualificado",
"lead_tags": [
"vip",
"suporte"
],
"lead_isTicketOpen": true,
"lead_assignedAttendant_id": "att_123456"
}CRM
Edits lead information
Updates the lead information associated with a chat. Allows modifying ticket status, agent assignment, kanban position, tags, and other custom fields.
Changes are immediately available in queries and in webhook/SSE events. to keep the application in sync.
POST
/
chat
/
editLead
Edits lead information
curl --request POST \
--url https://api.wppfy.com/chat/editLead \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "5511999999999@s.whatsapp.net",
"chatbot_disableUntil": -1,
"chatbot_agentResetMemoryAt": -1,
"lead_isTicketOpen": true,
"lead_assignedAttendant_id": "att_123456",
"lead_kanbanOrder": 1000,
"lead_tags": [
"vip",
"suporte",
"prioridade-alta"
],
"lead_name": "John Doe",
"lead_fullName": "John Smith Doe",
"lead_email": "joao@exemplo.com",
"lead_personalid": "123.456.789-00",
"lead_status": "qualificado",
"lead_notes": "Customer interested in premium plan",
"lead_field01": "<string>",
"lead_field02": "<string>",
"lead_field03": "<string>",
"lead_field04": "<string>",
"lead_field05": "<string>",
"lead_field06": "<string>",
"lead_field07": "<string>",
"lead_field08": "<string>",
"lead_field09": "<string>",
"lead_field10": "<string>",
"lead_field11": "<string>",
"lead_field12": "<string>",
"lead_field13": "<string>",
"lead_field14": "<string>",
"lead_field15": "<string>",
"lead_field16": "<string>",
"lead_field17": "<string>",
"lead_field18": "<string>",
"lead_field19": "<string>",
"lead_field20": "<string>"
}
'import requests
url = "https://api.wppfy.com/chat/editLead"
payload = {
"id": "5511999999999@s.whatsapp.net",
"chatbot_disableUntil": -1,
"chatbot_agentResetMemoryAt": -1,
"lead_isTicketOpen": True,
"lead_assignedAttendant_id": "att_123456",
"lead_kanbanOrder": 1000,
"lead_tags": ["vip", "suporte", "prioridade-alta"],
"lead_name": "John Doe",
"lead_fullName": "John Smith Doe",
"lead_email": "joao@exemplo.com",
"lead_personalid": "123.456.789-00",
"lead_status": "qualificado",
"lead_notes": "Customer interested in premium plan",
"lead_field01": "<string>",
"lead_field02": "<string>",
"lead_field03": "<string>",
"lead_field04": "<string>",
"lead_field05": "<string>",
"lead_field06": "<string>",
"lead_field07": "<string>",
"lead_field08": "<string>",
"lead_field09": "<string>",
"lead_field10": "<string>",
"lead_field11": "<string>",
"lead_field12": "<string>",
"lead_field13": "<string>",
"lead_field14": "<string>",
"lead_field15": "<string>",
"lead_field16": "<string>",
"lead_field17": "<string>",
"lead_field18": "<string>",
"lead_field19": "<string>",
"lead_field20": "<string>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '5511999999999@s.whatsapp.net',
chatbot_disableUntil: -1,
chatbot_agentResetMemoryAt: -1,
lead_isTicketOpen: true,
lead_assignedAttendant_id: 'att_123456',
lead_kanbanOrder: 1000,
lead_tags: ['vip', 'suporte', 'prioridade-alta'],
lead_name: 'John Doe',
lead_fullName: 'John Smith Doe',
lead_email: 'joao@exemplo.com',
lead_personalid: '123.456.789-00',
lead_status: 'qualificado',
lead_notes: 'Customer interested in premium plan',
lead_field01: '<string>',
lead_field02: '<string>',
lead_field03: '<string>',
lead_field04: '<string>',
lead_field05: '<string>',
lead_field06: '<string>',
lead_field07: '<string>',
lead_field08: '<string>',
lead_field09: '<string>',
lead_field10: '<string>',
lead_field11: '<string>',
lead_field12: '<string>',
lead_field13: '<string>',
lead_field14: '<string>',
lead_field15: '<string>',
lead_field16: '<string>',
lead_field17: '<string>',
lead_field18: '<string>',
lead_field19: '<string>',
lead_field20: '<string>'
})
};
fetch('https://api.wppfy.com/chat/editLead', 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.wppfy.com/chat/editLead",
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([
'id' => '5511999999999@s.whatsapp.net',
'chatbot_disableUntil' => -1,
'chatbot_agentResetMemoryAt' => -1,
'lead_isTicketOpen' => true,
'lead_assignedAttendant_id' => 'att_123456',
'lead_kanbanOrder' => 1000,
'lead_tags' => [
'vip',
'suporte',
'prioridade-alta'
],
'lead_name' => 'John Doe',
'lead_fullName' => 'John Smith Doe',
'lead_email' => 'joao@exemplo.com',
'lead_personalid' => '123.456.789-00',
'lead_status' => 'qualificado',
'lead_notes' => 'Customer interested in premium plan',
'lead_field01' => '<string>',
'lead_field02' => '<string>',
'lead_field03' => '<string>',
'lead_field04' => '<string>',
'lead_field05' => '<string>',
'lead_field06' => '<string>',
'lead_field07' => '<string>',
'lead_field08' => '<string>',
'lead_field09' => '<string>',
'lead_field10' => '<string>',
'lead_field11' => '<string>',
'lead_field12' => '<string>',
'lead_field13' => '<string>',
'lead_field14' => '<string>',
'lead_field15' => '<string>',
'lead_field16' => '<string>',
'lead_field17' => '<string>',
'lead_field18' => '<string>',
'lead_field19' => '<string>',
'lead_field20' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <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.wppfy.com/chat/editLead"
payload := strings.NewReader("{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<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.wppfy.com/chat/editLead")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/chat/editLead")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"5511999999999@s.whatsapp.net\",\n \"chatbot_disableUntil\": -1,\n \"chatbot_agentResetMemoryAt\": -1,\n \"lead_isTicketOpen\": true,\n \"lead_assignedAttendant_id\": \"att_123456\",\n \"lead_kanbanOrder\": 1000,\n \"lead_tags\": [\n \"vip\",\n \"suporte\",\n \"prioridade-alta\"\n ],\n \"lead_name\": \"John Doe\",\n \"lead_fullName\": \"John Smith Doe\",\n \"lead_email\": \"joao@exemplo.com\",\n \"lead_personalid\": \"123.456.789-00\",\n \"lead_status\": \"qualificado\",\n \"lead_notes\": \"Customer interested in premium plan\",\n \"lead_field01\": \"<string>\",\n \"lead_field02\": \"<string>\",\n \"lead_field03\": \"<string>\",\n \"lead_field04\": \"<string>\",\n \"lead_field05\": \"<string>\",\n \"lead_field06\": \"<string>\",\n \"lead_field07\": \"<string>\",\n \"lead_field08\": \"<string>\",\n \"lead_field09\": \"<string>\",\n \"lead_field10\": \"<string>\",\n \"lead_field11\": \"<string>\",\n \"lead_field12\": \"<string>\",\n \"lead_field13\": \"<string>\",\n \"lead_field14\": \"<string>\",\n \"lead_field15\": \"<string>\",\n \"lead_field16\": \"<string>\",\n \"lead_field17\": \"<string>\",\n \"lead_field18\": \"<string>\",\n \"lead_field19\": \"<string>\",\n \"lead_field20\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"wa_fastid": "5511888888888:5511999999999",
"wa_chatid": "5511999999999@s.whatsapp.net",
"lead_name": "João Silva",
"lead_status": "qualificado",
"lead_tags": [
"vip",
"suporte"
],
"lead_isTicketOpen": true,
"lead_assignedAttendant_id": "att_123456"
}Authorizations
Body
application/json
Chat identifier. Can be:
- wa_chatid (e.g.: "5511999999999@s.whatsapp.net")
- wa_fastid (e.g.: "5511888888888:5511999999999")
Example:
"5511999999999@s.whatsapp.net"
Pauses automation (AI, triggers, and flows) in this conversation until this time, in milliseconds. -1 pauses until someone turns it back on; 0 turns it back on.
Example:
-1
Resets the AI memory in the conversation: the agent starts reading only messages from this time (ms) onward. -1 is now (server time); 0 undoes it. A time in the future counts as now.
Example:
-1
Status of the ticket associated with the lead.
- true: Ticket is open/in service
- false: Ticket is closed/resolved
Example:
true
ID of the attendant assigned to the lead. Use an empty string ("") to remove the assignment.
Example:
"att_123456"
Card position on the kanban board. Higher values appear first.
Example:
1000
List of tags associated with the lead.
Non-existent tags are created automatically.
Tags with kanban=true represent the card's column.
Send an empty array ([]) to remove all tags.
Example:
["vip", "suporte", "prioridade-alta"]
Lead's main name
Example:
"John Doe"
Lead's full name
Example:
"John Smith Doe"
Lead email
Example:
"joao@exemplo.com"
Identification document (CPF/CNPJ) Numbers only or formatted
Example:
"123.456.789-00"
Free-form lead status in the sales funnel
Example:
"qualificado"
Notes about the lead
Example:
"Customer interested in premium plan"
Custom field 1
Custom field 2
Custom field 3
Custom field 4
Custom field 5
Custom field 6
Custom field 7
Custom field 8
Custom field 9
Custom field 10
Custom field 11
Custom field 12
Custom field 13
Custom field 14
Custom field 15
Custom field 16
Custom field 17
Custom field 18
Custom field 19
Custom field 20
Response
Updated lead. Includes the lead and chatbot fields of the conversation, not the whole Chat (no lead_awaitingReply, for example).
Represents a conversation/ticket in the system
Unique conversation ID (r + 7 random bytes in hex)
WhatsApp fast identifier
Full chat ID on WhatsApp
Chat LID on WhatsApp (when available)
Indicates whether the chat is archived
Name saved in the phone's address book for this number (empty: not saved). The conversation is created with it (by LID, via the linked number) and it changes when the contact is saved or deleted on the phone.
Name set by the user in the WhatsApp profile ("push name"). Comes from the contact's profile and may not be available depending on the context or data source.
Name resolved by the system as a fallback. It usually consolidates the best value available among internal data, the name coming from WhatsApp and the name saved in contacts. Therefore, it is more likely to be filled in.
Chat image URL
Image thumbnail URL
Parent community of the chat when it represents a subgroup
Show child attributes
Show child attributes
Expiration time for ephemeral messages
Indicates whether the contact is blocked
Indicates whether it is a group
Indicates whether the user is a group admin
Indicates whether it is an announcement-only group
Indicates whether it is a community
Indicates whether is a group member
Indicates whether the chat is pinned
Chat labels
Internal chat notes synced via app state
Text/vote of the last message
Type of the last message
Timestamp of the last message
Sender of the last message
true when the contact is awaiting a reply: the last message is theirs and no one has resolved the conversation (POST /lead/resolve). The contact's message turns it on; ours (you, the AI, a flow, or an integration) turns it off. In conversations predating this field, the api decides based on the sender (the instance's number or LID). Only in conversations with people: absent in groups and channels, which are not included in either filter, and when the conversation has no known last message (only the date). Filterable in /chat/find.
Timestamp of the end of muting
Instance owner
Unread message counter
Phone number
Groups in common separated by commas, format: (group_name)group_id
Example:
"Family Group(120363123456789012@g.us),Work(987654321098765432@g.us)"
Lead name
Lead's full name
Lead email
Identification document
Free-form lead status
Lead tags. Tags configured with kanban=true also determine the
columns in which the card appears in the Kanban.
Notes about the lead
Indicates whether there is an open ticket
ID of the responsible attendant
Order in the kanban
AI memory start (ms): the agent only reads the conversation messages from this point on. 0: no cutoff (the agent's window applies). Set via /chat/editLead.
ID of the last executed trigger
Timestamp of the last trigger
Automation (AI, triggers, and flows) paused in this conversation until this time, in milliseconds. -1: until someone turns it back on; 0: on.
Reason for the pause made by the automation: human request (AI or flow; paused until someone turns it back on) or AI reply limit (1-hour pause). Empty when there is no pause or after it ends. Turning it back on (chatbot_disableUntil: 0 in /chat/editLead) or resolving (POST /lead/resolve) clears it.