Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lfautomatiza.com/llms.txt

Use this file to discover all available pages before exploring further.

Funis são os pipelines do seu Kanban. Você pode ter quantos quiser (Vendas SMB, Vendas Enterprise, Renovação, Onboarding…), cada um com etapas próprias.

​
Endpoints

MétodoEndpointDescrição
GET/funnelsLista funis da conta
GET/funnels/:idDetalhe de um funil
POST/funnelsCria funil
PATCH PUT/funnels/:idAtualiza funil
DELETE/funnels/:idRemove funil e todos os itens dele
GET/funnels/:id/stage_statsMétricas agregadas por etapa
PATCH/funnels/:id/reorderReordena etapas
GET/funnels/:funnel_id/kanban_itemsLista itens deste funil
DELETE /funnels/:id é irreversível e remove em cascata todos os cards, notas, checklists e anexos vinculados. Considere arquivar via active: false em vez de deletar.

​
Criar funil

curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/funnels \
  -H "api_access_token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "funnel": {
      "name": "Vendas SMB",
      "description": "Pipeline comercial pra pequenas e médias empresas",
      "active": true,
      "is_default": false,
      "stages": {
        "lead": {
          "id": "lead",
          "name": "Lead",
          "color": "#94a3b8",
          "position": 1,
          "description": "Primeiro contato"
        },
        "qualified": {
          "id": "qualified",
          "name": "Qualificado",
          "color": "#3b82f6",
          "position": 2,
          "description": "Passou pelo SDR"
        },
        "proposal": {
          "id": "proposal",
          "name": "Proposta",
          "color": "#22c55e",
          "position": 3,
          "description": "Oferta enviada"
        },
        "won": {
          "id": "won",
          "name": "Ganho",
          "color": "#16a34a",
          "position": 4
        },
        "lost": {
          "id": "lost",
          "name": "Perdido",
          "color": "#dc2626",
          "position": 5
        }
      }
    }
  }'

​
Payload completo

{
  "funnel": {
    "name": "Vendas SMB",
    "description": "Pipeline comercial",
    "active": true,
    "is_default": false,
    "stages": {
      "lead": {
        "id": "lead",
        "name": "Lead",
        "color": "#94a3b8",
        "position": 1,
        "description": "Primeiro contato"
      }
    },
    "settings": {},
    "global_custom_attributes": []
  }
}

​
Campos

CampoTipoObrigatórioDescrição
namestring✅Nome do funil
descriptionstringTexto livre
activebooleanfalse arquiva sem deletar
is_defaultbooleanFunil padrão ao abrir Kanban
stagesobject✅Mapa de etapas (chave = id do stage)
settingsobjectConfigurações customizadas
global_custom_attributesarrayAtributos válidos pra todos os itens deste funil

​
Reordenar etapas

curl -X PATCH https://chat.lfautomatiza.com/api/v1/accounts/1/funnels/10/reorder \
  -H "api_access_token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stages": ["proposal", "lead", "qualified", "won", "lost"]
  }'
A ordem do array é a nova ordem visual. Os IDs precisam existir no funil.

​
Métricas por etapa

curl https://chat.lfautomatiza.com/api/v1/accounts/1/funnels/10/stage_stats \
  -H "api_access_token: $TOKEN"
Retorna contagem de cards e valor total por etapa, útil pra dashboards externos.