For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/reference/api/lead-context.md.
  • Português

      • Contexto completo do lead (leads_context)

      A tool leads_context do MCP da Clickmax retorna, em uma única chamada, tudo o que a plataforma sabe sobre um lead, organizado em 16 seções. É a chamada recomendada como primeiro passo quando a IA vai atender ou analisar um lead específico — sem precisar combinar várias tools para montar o cenário.

      Pré-requisito: um cliente de IA conectado ao MCP da Clickmax. Veja como conectar sua IA com OAuth.

      Seções retornadas

      Use os nomes abaixo no parâmetro sections para pedir só um subconjunto.

      SeçãoO que traz
      leadPerfil do lead: dados principais e de contato
      customFieldsValores dos campos customizados do lead, com as descrições dos campos
      tagsTags aplicadas ao lead
      listsListas em que o lead está
      opportunitiesOportunidades (cards) do lead, com pipeline, etapa e valor
      lostReasonsMotivos de perda registrados em oportunidades passadas
      notesObservações registradas no lead
      activitiesLinha do tempo de atividades do lead
      purchasesCompras na plataforma, vendas externas e LTV
      capturesCapturas de página e de funil, com UTMs
      formsRespostas de formulários e quizzes, com pontuação
      messagingContadores agregados da conversa (enviadas, lidas, recebidas, entregues e não lidas), últimas mensagens por conversa e disparos por canal
      appointmentsReuniões agendadas e tarefas
      membersAcesso à área de membros e progresso nos cursos
      flowsAutomações em que o lead entrou
      extrasWebinars, histórico de temperatura, empresas, sinal de conversa da IA e chamadas de voz/WhatsApp

      Parâmetros

      ParâmetroTipoObrigatórioEfeito
      leadIdid do leadsimLead cujo contexto será carregado
      sectionslista de nomes de seçãonãoRetorna apenas as seções pedidas; sem o parâmetro, retorna todas
      sincedata/hora ISO 8601nãoRestringe as seções temporais (atividades, mensagens, compras…) aos registros a partir dessa data
      limitPerSectioninteiro de 1 a 100nãoMáximo de itens por lista temporal; o padrão é 20. Não afeta as seções de estado, que retornam completas

      Truncamento e paginação

      O corte por limitPerSection e o campo totalCount valem para as listas temporais (janeladas): observações, atividades, compras (transações e vendas externas), respostas de formulários, conversas (das mais recentes para as mais antigas), agendamentos (reuniões e tarefas), automações e os históricos de extras (webinars, temperatura, chamadas). Cada uma dessas listas traz um totalCount com o total real de registros; se a lista veio com menos itens do que o totalCount, ela foi truncada pelo limitPerSection.

      As mensagens de cada conversa também são limitadas pelo limitPerSection, mas sem totalCount.

      As seções de estado — tags, listas, campos customizados, oportunidades, motivos de perda e empresas — retornam completas, sem corte e sem totalCount.

      O leads_context não pagina. Para percorrer todos os registros de uma seção, use a tool dedicada:

      SeçãoTool com paginação completa
      activitieslead_activities_list_by_lead
      opportunitiescards_list_by_lead
      purchasesleads_payments

      Leads mesclados

      Se o leadId informado pertence a um lead que foi mesclado em outro, a resposta traz o contexto do lead sobrevivente e inclui o campo resolvedFrom indicando o lead de origem e quando a mesclagem ocorreu.