Ficha do lead de uma conversa

Retorna a ficha do lead para o painel da conversa: nome, número de WhatsApp, version, bloqueio, responsável (owner e o nome em ownerName; se o nome não puder ser lido, a resposta é 500), o pedido para não receber mensagens (optedOutAt e optOutSource, ausentes quando o lead nunca pediu; optOut diz como o lead saiu, com a data, a origem, quem registrou, o tipo da prova, o trecho citado e quando a confirmação foi enviada, ausente quando o lead recebe ou quando a saída é anterior a esse registro), bairro e cidade do endereço principal (area), os campos personalizados (os sensíveis só para quem tem leads:read_sensitive) e as contagens de família (relativesCount) e de indicações (referredCount). Basta poder abrir a conversa: não exige leads:read, e o endereço completo nunca vem aqui. Responde 404 conversation_not_found quando a conversa está fora do que você pode abrir e 404 lead_not_found quando a conversa não tem lead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID da entrada (UUID)

Query Params
string

Tipo da entrada ('whatsapp', 'unofficial_whatsapp', 'instagram', 'telegram', 'facebook', 'webchat', 'email')

Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json