Skip to main content
POST
/
chat
/
editLead
Edita informações de lead
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": 1735686000,
  "lead_isTicketOpen": true,
  "lead_assignedAttendant_id": "att_123456",
  "lead_kanbanOrder": 1000,
  "lead_tags": [
    "vip",
    "suporte",
    "prioridade-alta"
  ],
  "lead_name": "João Silva",
  "lead_fullName": "João Silva Pereira",
  "lead_email": "joao@exemplo.com",
  "lead_personalId": "123.456.789-00",
  "lead_status": "qualificado",
  "lead_notes": "Cliente interessado em plano premium",
  "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>"
}
'
{
  "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

​
token
string
header
required

Body

application/json
​
id
string
required

Identificador do chat. Pode ser:

Example:

"5511999999999@s.whatsapp.net"

​
chatbot_disableUntil
integer<int64>

Timestamp UTC até quando o chatbot deve ficar desativado para este chat. Use 0 para reativar imediatamente.

Example:

1735686000

​
lead_isTicketOpen
boolean

Status do ticket associado ao lead.

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

true

​
lead_assignedAttendant_id
string

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

Example:

"att_123456"

​
lead_kanbanOrder
integer<int64>

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

Example:

1000

​
lead_tags
string[]

Lista de tags associadas ao lead. Tags inexistentes são criadas automaticamente. Envie array vazio ([]) para remover todas as tags.

Example:
["vip", "suporte", "prioridade-alta"]
​
lead_name
string

Nome principal do lead

Example:

"João Silva"

​
lead_fullName
string

Nome completo do lead

Example:

"João Silva Pereira"

​
lead_email
string<email>

Email do lead

Example:

"joao@exemplo.com"

​
lead_personalId
string

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

Example:

"123.456.789-00"

​
lead_status
string

Status do lead no funil de vendas

Example:

"qualificado"

​
lead_notes
string

Anotações sobre o lead

Example:

"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

Response

Lead atualizado com sucesso

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_archived
boolean
default:false

Indica se o chat está arquivado

​
wa_contactName
string
default:""

Nome do contato no WhatsApp

​
wa_name
string
default:""

Nome do WhatsApp

​
name
string
default:""

Nome exibido do chat

​
image
string
default:""

URL da imagem do chat

​
imagePreview
string
default:""

URL da miniatura da imagem

​
wa_ephemeralExpiration
integer<int64>
default:0

Tempo de expiração de mensagens efêmeras

​
wa_isBlocked
boolean
default:false

Indica se o contato está bloqueado

​
wa_isGroup
boolean
default:false

Indica se é um grupo

​
wa_isGroup_admin
boolean
default:false

Indica se o usuário é admin do grupo

​
wa_isGroup_announce
boolean
default:false

Indica se é um grupo somente anúncios

​
wa_isGroup_community
boolean
default:false

Indica se é uma comunidade

​
wa_isGroup_member
boolean
default:false

Indica se é membro do grupo

​
wa_isPinned
boolean
default:false

Indica se o chat está fixado

​
wa_label
string
default:[]

Labels do chat em JSON

​
wa_lastMessageTextVote
string
default:""

Texto/voto da última mensagem

​
wa_lastMessageType
string
default:""

Tipo da última mensagem

​
wa_lastMsgTimestamp
integer<int64>
default:0

Timestamp da última mensagem

​
wa_lastMessageSender
string
default:""

Remetente da última mensagem

​
wa_muteEndTime
integer<int64>
default:0

Timestamp do fim do silenciamento

​
owner
string
default:""

Dono da instância

​
wa_unreadCount
integer<int64>
default:0

Contador de mensagens não lidas

​
phone
string
default:""

Número de telefone

​
wa_common_groups
string
default:""

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

Example:

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

​
lead_name
string
default:""

Nome do lead

​
lead_fullName
string
default:""

Nome completo do lead

​
lead_email
string
default:""

Email do lead

​
lead_personalid
string
default:""

Documento de identificação

​
lead_status
string
default:""

Status do lead

​
lead_tags
string

Tags do lead em JSON

​
lead_notes
string
default:""

Anotações sobre o lead

​
lead_isTicketOpen
boolean
default:false

Indica se tem ticket aberto

​
lead_assignedAttendant_id
string
default:""

ID do atendente responsável

​
lead_kanbanOrder
integer<int64>
default:0

Ordem no kanban

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

Timestamp do último reset de memória

​
chatbot_lastTrigger_id
string
default:""

ID do último gatilho executado

​
chatbot_lastTriggerAt
integer<int64>
default:0

Timestamp do último gatilho

​
chatbot_disableUntil
integer<int64>
default:0

Timestamp até quando chatbot está desativado

​
created
string
default:strftime('%Y-%m-%d %H:%M:%f', 'now')

Data de criação

​
updated
string
default:strftime('%Y-%m-%d %H:%M:%f', 'now')

Data da última atualização