Pipelines
Consulte pipelines, com parâmetros e exemplos de requisição e resposta na API do iHelp.
Rota base: https://apiv3.ihelpchat.com/api/v2/crm/pipelines
"Pipeline" e "funil" são o mesmo objeto. A diferença é o caminho: os endpoints de /funnel (ver Funis e etapas) são o CRUD simples, enquanto os de /pipelines cobrem criação em cascata e gestão (arquivar, duplicar, permissões, exportar).
Profundidade desta página
Verbo, rota e o que cada endpoint faz. Os corpos de requisição não estão documentados campo a campo.
Criação e edição
| Método | Rota | Parâmetros | O que faz |
|---|---|---|---|
POST | /pipelines | body | Cria a pipeline completa (funil + etapas + regras + permissões) em uma única transação. Exige pelo menos uma etapa |
GET | /pipelines | - | Lista enriquecida: contagem de etapas e cards, valor total, taxa de conversão, dono, ativo e favorito por usuário |
GET | /pipelines/{id} | rota id | Detalhe completo para edição: funil, etapas ordenadas, regras e dono resolvido |
PATCH | /pipelines/{id} | rota id, body | Atualização parcial. Campos não informados preservam o valor atual. Se rules vier no corpo, substitui o conjunto inteiro de regras. Etapas não são editáveis por aqui |
DELETE | /pipelines/{id} | rota id | Soft delete em cascata: cards, etapas, tarefas, visões salvas e favoritos |
Gestão
| Método | Rota | Parâmetros | O que faz |
|---|---|---|---|
POST | /pipelines/{id}/set-default | rota id | Marca a pipeline como padrão da empresa e remove o padrão das demais |
POST | /pipelines/{id}/archive | rota id | Arquiva a pipeline (isActive: false) |
POST | /pipelines/{id}/unarchive | rota id | Desarquiva a pipeline |
POST | /pipelines/{id}/duplicate | rota id, body | Duplica a pipeline com etapas e regras. includeCards decide se os cards vêm junto |
POST | /pipelines/{id}/clear-cards | rota id | Soft delete de todos os cards do funil, incluindo ganhos e perdidos |
POST | /pipelines/reorder | body | Persiste a ordem das pipelines da empresa. Apenas administradores da empresa |
GET | /pipelines/{id}/export | rota id, query format=csv|xlsx | Exporta a pipeline. O xlsx traz múltiplas abas com KPIs, cards e etapas. Padrão: xlsx |
`clear-cards` é destrutivo
Remove todos os cards da pipeline de uma vez, sem seleção. A resposta traz deletedCount para conferência.
Permissões
| Método | Rota | Parâmetros | O que faz |
|---|---|---|---|
GET | /pipelines/{id}/permissions | rota id | Lista os membros e seus níveis de permissão |
PATCH | /pipelines/{id}/permissions | rota id, body members | Sincroniza as permissões da pipeline |
POST | /pipelines/{id}/permissions/resolve-email | rota id, body email | Resolve um e-mail para um membro da empresa. Só retorna usuários da mesma empresa |
Exceto a listagem e o reorder, todos os endpoints acima exigem nível Admin ou Owner na pipeline, ou administrador da empresa.
Motivos de perda
Rota base: https://apiv3.ihelpchat.com/api/v2/crm/loss-reasons
Alimentam o reasonId opcional de POST /card/{id}/close-lost (ver Cards).
| Método | Rota | Parâmetros | O que faz |
|---|---|---|---|
GET | /loss-reasons | - | Lista os motivos de perda da empresa, padrão primeiro e depois por ordem |
POST | /loss-reasons | body | Cria um motivo de perda. Apenas administradores |
PATCH | /loss-reasons/{id} | rota id, body | Atualiza parcialmente um motivo. Apenas administradores |
DELETE | /loss-reasons/{id} | rota id | Soft delete do motivo. Os registros históricos são preservados. Apenas administradores |