Skip to main content
POST
Edita la información del lead

Autorizaciones

token
string
header
requerido

Cuerpo

application/json
id
string
requerido

Identificador del chat. Puede ser:

Ejemplo:

"5511999999999@s.whatsapp.net"

chatbot_disableUntil
integer<int64>

Pausa la automatización (IA, disparadores y flujos) en esta conversación hasta este horario, en milisegundos. -1 pausa hasta que alguien la reactive; 0 la reactiva.

Ejemplo:

-1

chatbot_agentResetMemoryAt
integer<int64>

Reinicia la memoria de la IA en la conversación: el agente pasa a leer solo los mensajes a partir de esta hora (ms). -1 es ahora (la hora del servidor); 0 lo deshace. Una hora en el futuro cuenta como ahora.

Ejemplo:

-1

lead_isTicketOpen
boolean

Estado del ticket asociado al lead.

  • true: El ticket está abierto/en atención
  • false: El ticket está cerrado/resuelto
Ejemplo:

true

lead_assignedAttendant_id
string

ID del agente asignado al lead. Use una cadena vacía ("") para eliminar la asignación.

Ejemplo:

"att_123456"

lead_kanbanOrder
integer<int64>

Posición de la tarjeta en el tablero kanban. Los valores mayores aparecen primero.

Ejemplo:

1000

lead_tags
string[]

Lista de tags asociadas al lead. Las tags inexistentes se crean automáticamente. Las tags con kanban=true representan la columna de la tarjeta. Envíe un array vacío ([]) para eliminar todas las tags.

Ejemplo:
lead_name
string

Nombre principal del lead

Ejemplo:

"Juan Pérez"

lead_fullName
string

Nombre completo del lead

Ejemplo:

"Juan Pérez García"

lead_email
string<email>

Email del lead

Ejemplo:

"joao@exemplo.com"

lead_personalid
string

Documento de identificación (CPF/CNPJ) Solo números o con formato

Ejemplo:

"123.456.789-00"

lead_status
string

Estado libre del lead en el embudo de ventas

Ejemplo:

"qualificado"

lead_notes
string

Notas sobre el lead

Ejemplo:

"Cliente interesado en el plan 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

Respuesta

Lead actualizado. Incluye los campos del lead y del chatbot de la conversación, no el Chat completo (sin lead_awaitingReply, por ejemplo).

Representa una conversación/ticket en el sistema

id
string

ID único de la conversación (r + 7 bytes aleatorios en hex)

wa_fastid
string

Identificador rápido de WhatsApp

wa_chatid
string

ID completo del chat en WhatsApp

wa_chatlid
string

LID del chat en WhatsApp (cuando esté disponible)

wa_archived
boolean
predeterminado:false

Indica si el chat está archivado

wa_contactName
string
predeterminado:""

Nombre guardado en la agenda del teléfono para este número (vacío: no está guardado). La conversación se crea con él (por LID, mediante el número vinculado) y cambia cuando el contacto se guarda o se elimina en el teléfono.

wa_name
string
predeterminado:""

Nombre definido por el usuario en el perfil de WhatsApp ("push name"). Proviene del perfil del contacto y puede no estar disponible según el contexto o el origen de los datos.

name
string
predeterminado:""

Nombre resuelto por el sistema como fallback. Normalmente consolida el mejor valor disponible entre datos internos, el nombre proveniente de WhatsApp y el nombre guardado en los contactos. Por eso, suele tener mayor probabilidad de venir completado.

image
string
predeterminado:""

URL de la imagen del chat

imagePreview
string
predeterminado:""

URL de la miniatura de la imagen

parent_community
object

Comunidad principal del chat cuando representa un subgrupo

wa_ephemeralExpiration
integer<int64>
predeterminado:0

Tiempo de expiración de mensajes efímeros

wa_isBlocked
boolean
predeterminado:false

Indica si el contacto está bloqueado

wa_isGroup
boolean
predeterminado:false

Indica si es un grupo

wa_isGroup_admin
boolean
predeterminado:false

Indica si el usuario es admin del grupo

wa_isGroup_announce
boolean
predeterminado:false

Indica si es un grupo solo de anuncios

wa_isGroup_community
boolean
predeterminado:false

Indica si es una comunidad

wa_isGroup_member
boolean
predeterminado:false

Indica si es miembro del grupo

wa_isPinned
boolean
predeterminado:false

Indica si el chat está fijado

wa_label
string[]

Etiquetas del chat

wa_notes
string
predeterminado:""

Notas internas del chat sincronizadas mediante app state

wa_lastMessageTextVote
string
predeterminado:""

Texto/voto del último mensaje

wa_lastMessageType
string
predeterminado:""

Tipo del último mensaje

wa_lastMsgTimestamp
integer<int64>
predeterminado:0

Timestamp del último mensaje

wa_lastMessageSender
string
predeterminado:""

Remitente del último mensaje

lead_awaitingReply
boolean
read-only

true cuando el contacto espera respuesta: el último mensaje es suyo y nadie concluyó la conversación (POST /lead/resolve). El mensaje del contacto lo activa; el nuestro (usted, la IA, un flujo o una integración) lo desactiva. En las conversaciones anteriores a este campo, la api decide según el remitente (el número o el LID de la instancia). Solo en conversaciones con personas: ausente en grupos y canales, que no entran en ninguno de los dos filtros, y cuando la conversación no tiene un último mensaje conocido (solo la fecha). Filtrable en /chat/find.

wa_muteEndTime
integer<int64>
predeterminado:0

Timestamp del fin del silenciamiento

owner
string
predeterminado:""

Propietario de la instancia

wa_unreadCount
integer<int64>
predeterminado:0

Contador de mensajes no leídos

phone
string
predeterminado:""

Número de teléfono

common_groups
string
predeterminado:""

Grupos en común separados por coma, formato: (nombre_grupo)id_grupo

Ejemplo:

"Grupo Familia(120363123456789012@g.us),Trabajo(987654321098765432@g.us)"

lead_name
string
predeterminado:""

Nombre del lead

lead_fullName
string
predeterminado:""

Nombre completo del lead

lead_email
string
predeterminado:""

Email del lead

lead_personalid
string
predeterminado:""

Documento de identificación

lead_status
string
predeterminado:""

Estado libre del lead

lead_tags
string[]

Etiquetas del lead. Las etiquetas configuradas con kanban=true también determinan las columnas en las que aparece la tarjeta en el Kanban.

lead_notes
string
predeterminado:""

Notas sobre el lead

lead_isTicketOpen
boolean
predeterminado:false

Indica si tiene un ticket abierto

lead_assignedAttendant_id
string
predeterminado:""

ID del agente responsable

lead_kanbanOrder
integer<int64>
predeterminado:0

Orden en el kanban

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

Inicio de la memoria de la IA (ms): el agente solo lee los mensajes de la conversación a partir de aquí. 0: sin corte (se aplica la ventana del agente). Se guarda mediante /chat/editLead.

chatbot_lastTrigger_id
string
predeterminado:""

ID del último disparador ejecutado

chatbot_lastTriggerAt
integer<int64>
predeterminado:0

Timestamp del último disparador

chatbot_disableUntil
integer<int64>
predeterminado:0

Automatización (IA, disparadores y flujos) pausada en esta conversación hasta este horario, en milisegundos. -1: hasta que alguien la vuelva a activar; 0: activada.

chatbot_summary
string
predeterminado:""

Motivo de la pausa realizada por la automatización: solicitud de humano (IA o flujo; pausa hasta que alguien la reactive) o límite de respuestas de la IA (pausa de 1 hora). Vacío cuando no hay pausa o después de que termina. Reactivar (chatbot_disableUntil: 0 en /chat/editLead) o concluir (POST /lead/resolve) lo limpia.