Funil e negócios
Funis, etapas, negócios e notas.
Funis organizam negócios em etapas (colunas). Cada funil tem ao menos uma etapa aberta; etapas podem ser de ganho ou de perda. O módulo Funil precisa estar no plano.
- Permissões:
funil:ler,funil:escrever(criar, editar, mover, ganhar, perder, anotar) efunil:apagar(apagar negócios, notas, etapas e funis, sem volta), separada de propósito. - Negócio sem funil vai para o primeiro funil; sem etapa, para a primeira etapa aberta. Sem título, usa o nome do contato.
- Valores em centavos (
valor_centavos);previsaoé a data prevista de fechamento (AAAA-MM-DD). - Mover para uma etapa de ganho ou de perda tem o mesmo efeito de ganhar ou perder.
reabrirvolta para a primeira etapa aberta. - Apagar uma etapa move os negócios dela para
destino_id(ou para a primeira etapa aberta). - Limites: 20 funis por organização, 30 etapas por funil, 500 notas por negócio.
- Eventos de webhook:
negocio.criado,negocio.movido,negocio.ganhoenegocio.perdido.
Para uma etapa de perda, com motivo
{
"etapa_id": "8bd304cb-bbac-4aba-b321-d894b0fe5669",
"motivo": "Achou mais barato em outro lugar"
}Endpoints#
- GETListar funis
/funis - POSTCriar funil
/funis - GETVer um funil
/funis/{id} - PATCHRenomear funil
/funis/{id} - DELApagar funil
/funis/{id} - POSTCriar etapa
/etapas - GETVer uma etapa
/etapas/{id} - PATCHAtualizar etapa
/etapas/{id} - DELApagar etapa
/etapas/{id} - GETListar negócios
/negocios - POSTCriar negócio
/negocios - GETVer um negócio
/negocios/{id} - PATCHAtualizar negócio
/negocios/{id} - DELApagar negócio
/negocios/{id} - POSTMover para outra etapa
/negocios/{id}/mover - POSTMarcar como ganho
/negocios/{id}/ganhar - POSTMarcar como perdido
/negocios/{id}/perder - POSTReabrir negócio
/negocios/{id}/reabrir - GETNotas de um negócio
/negocios/{id}/notas - POSTAnotar no negócio
/negocios/{id}/notas - DELApagar uma nota
/negocios/notas/{id}
Códigos de erro#
Além dos gerais (chave, limite, JSON), estes podem vir em erro.codigo nas rotas daqui. Todos estão em Erros.
| codigo | O que significa |
|---|---|
| funil_inexistente | Funil não encontrado. |
| etapa_inexistente | Etapa não encontrada (veja GET /funis). |
| negocio_inexistente | Negócio não encontrado. |
| nota_inexistente | Nota não encontrada. |
| etapa_fora_do_funil | Essa etapa não pertence ao funil informado. |
| etapa_ganha_e_perdida | Uma etapa não pode ser de ganho e de perda ao mesmo tempo. |
| estado_invalido | estado deve ser aberto, ganho ou perdido. |
| valor_invalido | O valor não pode ser negativo. |
| limite_de_funis | Limite de 20 funis por organização. |
| limite_de_etapas | Limite de 30 etapas por funil. |
| limite_de_notas | Limite de 500 notas por negócio. |
| contato_inexistente | Contato não encontrado. |
| conversa_inexistente | Conversa não encontrada. |