Separar estrutura e automações

As rotas deste guia criam pipelines e etapas. Elas não configuram as Ações do Pipeline da interface, responsáveis por automações associadas ao funil.

Formulário Novo Pipeline com nome e configuração de etapas
A interface possui controles adicionais; a API publicada confirma apenas os campos de cada rota descritos abaixo.

Gerenciar pipelines

  • Criar: POST /v2/api/external/{ApiID}/pipeline/create com name e description.
  • Listar: GET .../pipeline/list com page e limit.
  • Consultar: GET .../pipeline/show/{id}.
  • Atualizar: POST .../pipeline/update/{id}; o schema publicado apresenta somente name.
  • Excluir: POST .../pipeline/delete/{id}.
  1. 1

    Liste os pipelines existentes para evitar nomes e estruturas duplicadas.

  2. 2

    Crie um pipeline de homologação e guarde o ID retornado pela sua versão.

  3. 3

    Consulte o pipeline pelo ID e confirme nome e descrição.

  4. 4

    Use a rota de atualização somente para o campo publicado.

  5. 5

    Exclua apenas uma estrutura vazia e criada para teste.

Criar e consultar etapas

  • Criar: POST .../stage/create com name, pipelineId, order e color.
  • Listar: GET .../stage/list com page, limit e pipelineId.
  • Consultar: GET .../stage/show/{id}.
  • Atualizar: POST .../stage/update/{id}; o schema publicado apresenta somente name.
  • Excluir: POST .../stage/delete/{id}.
  1. 1

    Crie todas as etapas na ordem planejada.

  2. 2

    Use cores válidas e consistentes com o padrão visual da operação.

  3. 3

    Liste as etapas filtrando pelo pipelineId.

  4. 4

    Consulte cada etapa e registre o mapeamento entre nome funcional e ID.

  5. 5

    Valide o pipeline no Kanban antes de criar oportunidades.

Conhecer os limites publicados

Dashboard do Funil de Vendas com abas Kanban e Pipelines
Confirme na interface se a estrutura criada pela API aparece corretamente antes de vinculá-la à operação.
  • StageUpdate não publica alteração de order, color ou pipelineId.
  • PipelineUpdate não publica atualização de description.
  • Excluir e recriar etapas para mudar a ordem pode quebrar referências e não deve ser automatizado.
  • Pipeline com oportunidades vinculadas não deve ser excluído; mova ou encerre os vínculos de forma controlada.
  • O efeito de excluir uma etapa com oportunidades não está documentado; verifique vínculos e não repita a exclusão em caso de dúvida.

Validar a estrutura completa

  1. 1

    Liste e consulte o pipeline criado.

  2. 2

    Liste as etapas filtradas pelo pipeline e confirme ordem, nomes e cores.

  3. 3

    Crie uma oportunidade fictícia para validar a relação entre pipeline e etapa.

  4. 4

    Confira a oportunidade no Kanban e no Dashboard do Funil.

  5. 5

    Remova somente os registros de homologação depois de confirmar que não há vínculos remanescentes.

  • Etapa ausente: confira pipelineId e paginação.
  • Ordem incorreta: revise order na criação; a atualização de ordem não está publicada.
  • Cor não muda: StageUpdate publica somente name.
  • Pipeline não exclui: procure oportunidades vinculadas antes de qualquer nova tentativa.