Skip to main content
POST
Edita informações de lead

Autorizações

token
string
header
obrigatório

Corpo

application/json
id
string
obrigatório

Identificador do chat. Pode ser:

Exemplo:

"5511999999999@s.whatsapp.net"

chatbot_disableUntil
integer<int64>

Pausa a automação (IA, gatilhos e fluxos) nesta conversa até este horário, em milissegundos. -1 pausa até alguém religar; 0 religa.

Exemplo:

-1

chatbot_agentResetMemoryAt
integer<int64>

Zera a memória da IA na conversa: o agente passa a ler só as mensagens a partir deste horário (ms). -1 é agora (a hora do servidor); 0 desfaz. Horário no futuro vale como agora.

Exemplo:

-1

lead_isTicketOpen
boolean

Status do ticket associado ao lead.

  • true: Ticket está aberto/em atendimento
  • false: Ticket está fechado/resolvido
Exemplo:

true

lead_assignedAttendant_id
string

ID do atendente atribuído ao lead. Use string vazia ("") para remover a atribuição.

Exemplo:

"att_123456"

lead_kanbanOrder
integer<int64>

Posição do card no quadro kanban. Valores maiores aparecem primeiro.

Exemplo:

1000

lead_tags
string[]

Lista de tags associadas ao lead. Tags inexistentes são criadas automaticamente. Tags com kanban=true representam a coluna do cartão. Envie array vazio ([]) para remover todas as tags.

Exemplo:
lead_name
string

Nome principal do lead

Exemplo:

"João Silva"

lead_fullName
string

Nome completo do lead

Exemplo:

"João Silva Pereira"

lead_email
string<email>

Email do lead

Exemplo:

"joao@exemplo.com"

lead_personalid
string

Documento de identificação (CPF/CNPJ) Apenas números ou formatado

Exemplo:

"123.456.789-00"

lead_status
string

Status livre do lead no funil de vendas

Exemplo:

"qualificado"

lead_notes
string

Anotações sobre o lead

Exemplo:

"Cliente interessado em plano premium"

lead_field01
string

Campo personalizado 1

lead_field02
string

Campo personalizado 2

lead_field03
string

Campo personalizado 3

lead_field04
string

Campo personalizado 4

lead_field05
string

Campo personalizado 5

lead_field06
string

Campo personalizado 6

lead_field07
string

Campo personalizado 7

lead_field08
string

Campo personalizado 8

lead_field09
string

Campo personalizado 9

lead_field10
string

Campo personalizado 10

lead_field11
string

Campo personalizado 11

lead_field12
string

Campo personalizado 12

lead_field13
string

Campo personalizado 13

lead_field14
string

Campo personalizado 14

lead_field15
string

Campo personalizado 15

lead_field16
string

Campo personalizado 16

lead_field17
string

Campo personalizado 17

lead_field18
string

Campo personalizado 18

lead_field19
string

Campo personalizado 19

lead_field20
string

Campo personalizado 20

Resposta

Lead atualizado. Traz os campos do lead e do chatbot da conversa, não o Chat inteiro (sem lead_awaitingReply, por exemplo).

Representa uma conversa/chamado no sistema

id
string

ID único da conversa (r + 7 bytes aleatórios em hex)

wa_fastid
string

Identificador rápido do WhatsApp

wa_chatid
string

ID completo do chat no WhatsApp

wa_chatlid
string

LID do chat no WhatsApp (quando disponível)

wa_archived
boolean
padrão:false

Indica se o chat está arquivado

wa_contactName
string
padrão:""

Nome salvo na agenda do celular deste número (vazio: não está salvo). A conversa nasce com ele (por LID, pelo número ligado) e ele muda quando o contato é salvo ou apagado no celular.

wa_name
string
padrão:""

Nome definido pelo usuário no perfil do WhatsApp ("push name"). Vem do perfil do contato e pode não estar disponível dependendo do contexto ou da origem dos dados.

name
string
padrão:""

Nome resolvido pelo sistema como fallback. Normalmente consolida o melhor valor disponível entre dados internos, nome vindo do WhatsApp e nome salvo nos contatos. Por isso, costuma ter maior chance de vir preenchido.

image
string
padrão:""

URL da imagem do chat

imagePreview
string
padrão:""

URL da miniatura da imagem

parent_community
object

Comunidade pai do chat quando ele representa um subgrupo

wa_ephemeralExpiration
integer<int64>
padrão:0

Tempo de expiração de mensagens efêmeras

wa_isBlocked
boolean
padrão:false

Indica se o contato está bloqueado

wa_isGroup
boolean
padrão:false

Indica se é um grupo

wa_isGroup_admin
boolean
padrão:false

Indica se o usuário é admin do grupo

wa_isGroup_announce
boolean
padrão:false

Indica se é um grupo somente anúncios

wa_isGroup_community
boolean
padrão:false

Indica se é uma comunidade

wa_isGroup_member
boolean
padrão:false

Indica se é membro do grupo

wa_isPinned
boolean
padrão:false

Indica se o chat está fixado

wa_label
string[]

Labels do chat

wa_notes
string
padrão:""

Anotações internas do chat sincronizadas via app state

wa_lastMessageTextVote
string
padrão:""

Texto/voto da última mensagem

wa_lastMessageType
string
padrão:""

Tipo da última mensagem

wa_lastMsgTimestamp
integer<int64>
padrão:0

Timestamp da última mensagem

wa_lastMessageSender
string
padrão:""

Remetente da última mensagem

lead_awaitingReply
boolean
read-only

true quando o contato espera resposta: a última mensagem é dele e ninguém concluiu a conversa (POST /lead/resolve). A mensagem do contato liga; a nossa (você, a IA, um fluxo ou uma integração) desliga. Nas conversas anteriores a este campo, a api decide pelo remetente (o número ou o LID da instância). Só em conversas com pessoas: ausente em grupos e canais, que não entram em nenhum dos dois filtros, e quando a conversa não tem última mensagem conhecida (só a data). Filtrável no /chat/find.

wa_muteEndTime
integer<int64>
padrão:0

Timestamp do fim do silenciamento

owner
string
padrão:""

Dono da instância

wa_unreadCount
integer<int64>
padrão:0

Contador de mensagens não lidas

phone
string
padrão:""

Número de telefone

common_groups
string
padrão:""

Grupos em comum separados por vírgula, formato: (nome_grupo)id_grupo

Exemplo:

"Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)"

lead_name
string
padrão:""

Nome do lead

lead_fullName
string
padrão:""

Nome completo do lead

lead_email
string
padrão:""

Email do lead

lead_personalid
string
padrão:""

Documento de identificação

lead_status
string
padrão:""

Status livre do lead

lead_tags
string[]

Tags do lead. Tags configuradas com kanban=true também determinam as colunas em que o cartão aparece no Kanban.

lead_notes
string
padrão:""

Anotações sobre o lead

lead_isTicketOpen
boolean
padrão:false

Indica se tem ticket aberto

lead_assignedAttendant_id
string
padrão:""

ID do atendente responsável

lead_kanbanOrder
integer<int64>
padrão:0

Ordem no kanban

lead_field01
string
padrão:""
lead_field02
string
padrão:""
lead_field03
string
padrão:""
lead_field04
string
padrão:""
lead_field05
string
padrão:""
lead_field06
string
padrão:""
lead_field07
string
padrão:""
lead_field08
string
padrão:""
lead_field09
string
padrão:""
lead_field10
string
padrão:""
lead_field11
string
padrão:""
lead_field12
string
padrão:""
lead_field13
string
padrão:""
lead_field14
string
padrão:""
lead_field15
string
padrão:""
lead_field16
string
padrão:""
lead_field17
string
padrão:""
lead_field18
string
padrão:""
lead_field19
string
padrão:""
lead_field20
string
padrão:""
chatbot_agentResetMemoryAt
integer<int64>
padrão:0

Início da memória da IA (ms): o agente só lê as mensagens da conversa a partir daqui. 0: sem corte (vale a janela do agente). Grave pelo /chat/editLead.

chatbot_lastTrigger_id
string
padrão:""

ID do último gatilho executado

chatbot_lastTriggerAt
integer<int64>
padrão:0

Timestamp do último gatilho

chatbot_disableUntil
integer<int64>
padrão:0

Automação (IA, gatilhos e fluxos) pausada nesta conversa até este horário, em milissegundos. -1: até alguém religar; 0: ligada.

chatbot_summary
string
padrão:""

Motivo da pausa feita pela automação: pedido de humano (IA ou fluxo; pausa até alguém religar) ou limite de respostas da IA (pausa de 1 hora). Vazio quando não há pausa ou depois que ela acaba. Religar (chatbot_disableUntil: 0 no /chat/editLead) ou concluir (POST /lead/resolve) limpa.