# POST /funis — Criar funil

- URL: `POST https://chat.forsi.com.br/api/v1/funis`
- Acesso: escopo `funil:escrever` · módulos do plano: API + Funil · aceita `Idempotency-Key`
- Sucesso: `201`, `{"dados": ...}` com `Funil`
- Página: https://docs.forsi.com.br/api/funil/criar-funil (Markdown: https://docs.forsi.com.br/api/funil/criar-funil.md)

Até 20 funis e 30 etapas por funil. Sem `etapas`, usa o modelo do segmento. Mande `Idempotency-Key` para poder repetir com segurança.

**Corpo (JSON)**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `nome` | string | sim | até 60 caracteres |
| `etapas` | lista de object | não | Sem etapas, o funil nasce com o modelo do segmento da organização. Precisa de pelo menos uma etapa que não seja de ganho nem de perda. mín. 1 item até 30 itens |
| `etapas[].nome` | string | sim | até 40 caracteres |
| `etapas[].cor` | "slate" \| "blue" \| "violet" \| "amber" \| "emerald" \| "green" \| "rose" \| "cyan" \| "orange" | não |  |
| `etapas[].ganha` | boolean | não | Etapa de ganho: negócio que chega aqui vira ganho. |
| `etapas[].perdida` | boolean | não | Etapa de perda: negócio que chega aqui vira perdido. |

**Exemplo (curl)**

```bash
curl -X POST "https://chat.forsi.com.br/api/v1/funis" \
  -H "Authorization: Bearer $FORSI_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-4821" \
  -d '{
    "nome": "Implantes",
    "etapas": [
      {"nome":"Avaliação","cor":"blue"},
      {"nome":"Orçamento enviado","cor":"amber"},
      {"nome":"Fechado","cor":"green","ganha":true},
      {"nome":"Desistiu","cor":"rose","perdida":true}
    ]
  }'
```

**JavaScript (fetch)**

```js
const resposta = await fetch('https://chat.forsi.com.br/api/v1/funis', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FORSI_CHAVE}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'pedido-4821',
  },
  body: JSON.stringify({
    "nome": "Implantes",
    "etapas": [
      {"nome":"Avaliação","cor":"blue"},
      {"nome":"Orçamento enviado","cor":"amber"},
      {"nome":"Fechado","cor":"green","ganha":true},
      {"nome":"Desistiu","cor":"rose","perdida":true}
    ]
  }),
});
const json = await resposta.json();
if (!resposta.ok) throw new Error(`${resposta.status} ${json.erro.codigo}: ${json.erro.mensagem}`);
console.log(json.dados);
```

**Python (requests)**

```python
import os
import requests

resposta = requests.post(
    "https://chat.forsi.com.br/api/v1/funis",
    headers={
        "Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
        "Idempotency-Key": "pedido-4821",
    },
    json={
        "nome": "Implantes",
        "etapas": [
            {
                "nome": "Avaliação",
                "cor": "blue",
            },
            {
                "nome": "Orçamento enviado",
                "cor": "amber",
            },
            {
                "nome": "Fechado",
                "cor": "green",
                "ganha": True,
            },
            {
                "nome": "Desistiu",
                "cor": "rose",
                "perdida": True,
            },
        ],
    },
    timeout=30,
)
corpo = resposta.json()
if not resposta.ok:
    raise RuntimeError(f"{resposta.status_code} {corpo['erro']['codigo']}: {corpo['erro']['mensagem']}")
print(corpo["dados"])
```

**Resposta `201` (exemplo)**

```json
{
  "dados": {
    "id": "182aeb59-9ecb-47b2-a745-dfa6f21ea385",
    "nome": "Implantes",
    "posicao": 0,
    "etapas": [{"id":"929692a6-7c6e-4f64-988f-e3a786bb5349"}],
    "criado_em": "2026-10-04T13:05:12.481Z",
    "atualizado_em": "2026-10-04T13:05:12.481Z"
  }
}
```

**Campos de `Funil`**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | não |  |
| `nome` | string | não |  |
| `posicao` | integer | não |  |
| `etapas` | lista de Etapa | não |  |
| `criado_em` | data e hora ISO 8601 | não |  |
| `atualizado_em` | data e hora ISO 8601 | não |  |

**Erros**

- `401`: Chave ausente ou inválida (resposta igual para qualquer motivo).
- `403`: Plano sem API, escopo insuficiente ou https/origem recusados.
- `409`: Conflito (repetido, Idempotency-Key com outro corpo).
- `422`: Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
- `429`: Limite de requisições. Veja Retry-After.
- Códigos comuns aqui: `funil_inexistente`, `etapa_inexistente`, `negocio_inexistente`, `nota_inexistente`, `etapa_fora_do_funil`, `etapa_ganha_e_perdida`, `estado_invalido`, `valor_invalido`, `limite_de_funis`, `limite_de_etapas`, `limite_de_notas`, `contato_inexistente`, `conversa_inexistente`.

---

Página: https://docs.forsi.com.br/api/funil/criar-funil · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt