Sign in

v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Leads

Qualificar Lead (Filtro ou Feedback)

Este endpoint possui dois casos de uso, determinados pela etapa atual do lead.

Leads - Aplicar Filtro

Este endpoint é utilizado para passar o lead pelas etapas do funil com base nas perguntas e respostas definidas pela empresa.

Verifique no endpoint de Etapas - perguntas e respostas [/Answers], os ids das perguntas e respostas. Em caso de perguntas que dependem de resposta anterior, coloque o id da pergunta e id da resposta em sequência e envie um payload para cada filtro.

Campos utilizados para aplicar filtro:

  • painPoints (opcional, lista) — Lista de identificadores de dores. Consultar [/PainPoints].
  • products (opcional, lista) — Consultar a lista de produtos no endpoint [/products].

Campos obrigatórios:

  • leadId (obrigatório) — Id do Lead.
  • answersList (obrigatório) — Lista de respostas para avaliação do filtro:
    • questionId (obrigatório) — Identificador da Pergunta.
    • questionType (obrigatório) — Tipo da Resposta:
      • 1 (Multiple) — resposta múltipla
      • 2 (Unique) — resposta única
      • 3 (Open) — texto livre
    • text (obrigatório se questionType = 3) — Texto da resposta para pergunta aberta.
    • answersIds (obrigatório se questionType = 1 ou 2) — Lista de identificadores de resposta.

Observação: painPoints e products tornam-se obrigatórios quando o questionário da etapa exige dor ou produto.

Leads - Aplicar Feedback

Este endpoint tem a finalidade de inserir respostas às perguntas de feedback da reunião. Verificar o stage do lead no endpoint [/Leads] e consultar o endpoint de etapas perguntas e respostas [/Answers], inserindo as respostas da etapa Feedback de reunião.

Campos obrigatórios:

  • leadId (obrigatório) — Id do Lead.
  • answersList (obrigatório) — Lista de respostas:
    • questionId (obrigatório) — Id da pergunta.
    • questionType (obrigatório) — Tipo da Resposta:
      • 1 (Multiple) — resposta múltipla
      • 2 (Unique) — resposta única
      • 3 (Open) — resposta aberta
    • text (obrigatório se questionType = 3) — Texto da resposta para pergunta aberta.
    • answersIds (obrigatório se questionType = 1 ou 2) — Lista de identificadores de resposta.
  • continueNegotiation (obrigatório no feedback) — Continuar negociação? true = Sim, false = Não.
post/leadsQualification

Request body

leadIdinteger required

Id do Lead.

painPointsinteger[]

Lista de identificadores de dores. Obrigatório quando o questionário exige dor. Consultar [/PainPoints].

productsinteger[]

Lista de identificadores de produtos. Obrigatório quando o questionário exige produto. Consultar [/products].

continueNegotiationboolean

Continuar negociação? Obrigatório no caso de feedback de reunião. true = Sim, false = Não.

Example request

{
  "leadId": 609645,
  "painPoints": [
    4265,
    4265
  ],
  "products": [
    4326,
    4327
  ],
  "continueNegotiation": true
}

Response

Qualificação realizada com sucesso. A mensagem retornada indica o resultado (ex. lead qualificado, lead perdido por score insuficiente ou recusa de negociação).

string required

Example response

"Lead Qualified! The score achieved is: {qualificação}"