> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinglog.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Leia /llms.txt antes de explorar páginas. A API HTTP usa Authorization: Bearer com o JWT da conta. A chave kl_live_ serve só ao assistente MCP e não substitui o JWT. Não invente rotas, hosts públicos, SDKs ou CLI. companyId e userId vêm da sessão. Consultas não aceitam SQL. Exclusão no assistente exige confirm=true. O webhook público é POST /webhook/leads.

# Lead

> O negócio no funil. `stage` nulo é aberto. `won`, `lost` e `delete` fecham. Mover de coluna não é a mesma operação que mover de etapa.

O negócio no funil. `stage` nulo é aberto. `won`, `lost` e `delete` fecham. Mover de coluna não é a mesma operação que mover de etapa.

> [card] Obrigatório
>
> `name`, `title`, `value` (inteiro maior ou igual a 0), `currency` (`BRL`, `USD`, `EUR` ou `GBP`) e `column_id`.

## Fluxo

1. Liste as colunas do funil.
2. Crie o lead com nome, título, valor, moeda e `column_id`.
3. Mova de coluna ou de etapa com as operações próprias.

## Enums

| Campo | Valores |
| - | - |
| `currency` | BRL, USD, EUR, GBP |
| `stage` | nulo (aberto), won, lost, delete |

## Operações

| Você quer | Método | Caminho |
| - | - | - |
| [Leads](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-list.md) | `GET` | `/crm/lead/getAll/:companyId/:userId` |
| [Um lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-getOne.md) | `GET` | `/crm/getOneLead/:companyId/:userId/:id` |
| [Criar lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-create.md) | `POST` | `/crm/newLead` |
| [Atualizar lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-update.md) | `PUT` | `/crm/lead/update` |
| [Excluir lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-delete.md) | `DELETE` | `/crm/lead/delete/:companyId/:userId/:leadId` |
| [Estágio do lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-moveStage.md) | `PUT` | `/crm/lead/stage/:companyId/:userId/:leadId/:stage` |
| [Coluna do lead](https://docs.kinglog.com.br/pages/reference/crm/crm-leads-moveColumn.md) | `PUT` | `/crm/lead/CrmColumnStage/:companyId/:userId/:leadId/:columnId` |

## Exemplo de requisição

```json theme={null}
{
  "name": "Ana Lima",
  "title": "Interesse no plano anual",
  "value": 0,
  "currency": "BRL",
  "column_id": "ID_DA_COLUNA",
  "companyId": "UUID_DA_EMPRESA",
  "userId": "UUID_DO_USUARIO"
}
```

## Exemplo de resposta

```json theme={null}
{
  "success": true,
  "data": {
    "id": "ID_DO_LEAD",
    "name": "Ana Lima",
    "title": "Interesse no plano anual",
    "value": 0,
    "currency": "BRL",
    "column_id": "ID_DA_COLUNA",
    "stage": null
  },
  "code": "SUCCESS"
}
```

> [!TIP]
>
> Liste as colunas do funil antes e use o `column_id` devolvido.

## Relacionado

* [Guia: criar um lead](https://docs.kinglog.com.br/pages/guides/criar-lead.md)
* [Guia: mover um lead](https://docs.kinglog.com.br/pages/guides/mover-lead.md)
* [Contato](https://docs.kinglog.com.br/pages/reference/crm/contato.md)
* [Webhook](https://docs.kinglog.com.br/pages/webhooks/leads.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.