CUBO CRM
    CUBO CRM
    • Comece por aqui
    • Activities
      • Listar todas as atividades
        GET
      • Criar nova atividade
        POST
      • Obter atividade por ID
        GET
      • Atualizar atividade
        PUT
      • Excluir atividade
        DELETE
    • Annotation
      • Criar nova anotação
        POST
      • Obter anotação por ID
        GET
      • Atualizar anotação
        PUT
      • Excluir anotação
        DELETE
    • Apikey
      • Listar todas as apikeys
        GET
      • Criar nova apikey
        POST
      • Obter apikey por ID
        GET
      • Atualizar apikey
        PUT
      • Excluir apikey
        DELETE
    • Category
      • Listar todas as categorias
        GET
      • Criar nova categoria
        POST
      • Obter categoria por ID
        GET
      • Atualizar categoria
        PUT
      • Excluir categoria
        DELETE
    • Company
      • Obter empresa
        GET
      • Atualizar empresa
        PUT
    • Custom Field
      • Listar todos os campos personalizados
        GET
      • Criar novo campo personalizado
        POST
      • Obter campo personalizado por ID
        GET
      • Atualizar campo personalizado
        PUT
      • Excluir campo personalizado
        DELETE
    • Deal
      • Listar todos os negócios
      • Criar novo negócio
      • Obter negócio por ID
      • Atualizar negócio
      • Excluir negócio
    • Domain
      • Listar todos os domínios
      • Criar novo domínio
      • Obter domínio por ID
      • Excluir domínio
    • LostReason
      • Listar todos os motivos de perda
      • Criar motivo de perda
      • Obter motivo de perda por ID
      • Atualizar motivo de perda
      • Excluir motivo de perda
    • Organization
      • Listar todas as organizações
      • Criar nova organização
      • Obter organização por ID
      • Atualizar organização
      • Excluir organização
    • People
      • Listar todas as pessoas
      • Criar nova pessoa
      • Obter pessoa por ID
      • Atualizar pessoa
      • Excluir pessoa
    • Pipe
      • Listar todos os funis
      • Criar novo funil
      • Listar funil por ID
      • Atualizar Funil
      • Excluir funil
    • Product
      • Listar todos os produtos
      • Criar novo produto
      • Obter produto por ID
      • Atualizar produto
      • Excluir produto
    • Proposal
      • Listar todos as propostas
      • Criar proposta para negociação pelo ID
      • Obter proposta por ID
      • Atualizar proposta
    • Stage
      • Buscar todos os estágios do funil pelo ID
      • Criar estágios
      • Obter estágios por ID
      • Atualizar estágio
      • Excluir estágio
    • Template
      • Listar todos os templates de mensagem
      • Criar template de mensagem
      • Criar template de mensagem para negócio pelo ID
      • Obter template de mensagem por ID
      • Atualizar template de mensagem
      • Excluir template de mensagem
    • Webhooks
      • Receber dados do BotConversa para criação
      • Receber dados do BotConversa para atualização
      • Receber dados do ManyChat para criação
      • Receber dados do ManyChat para atualização

    Stage

    Entidade: Stage#

    Visão Geral#

    A entidade Stage representa as etapas de um pipeline, usadas para organizar o progresso das negociações. Cada etapa é vinculada a um pipeline e empresa, com suporte a campos personalizados.

    Estrutura da Entidade#

    Campos Principais#

    CampoTipoDescriçãoObrigatório
    idnumberIdentificador único da etapa✅ (auto)
    namestringNome descritivo da etapa✅
    pipeIdnumberID do pipeline associado✅
    orderNrnumberOrdem da etapa no pipeline✅ (auto)
    lightBackgroundstringCor de fundo para tema claro❌
    darkBackgroundstringCor de fundo para tema escuro❌
    companyIdnumberID da empresa proprietária (via pipeline)✅ (auto)
    createdAtDateTimeData/hora de criação✅ (auto)
    updatedAtDateTimeData/hora da última atualização✅ (auto)

    Relacionamentos#

    Pipe: Vinculada a um pipeline específico.
    Company: Vinculada à empresa do usuário (via pipeline).
    Deals: Relaciona-se com negociações na etapa.
    Customfields: Suporta campos personalizados.

    Status Disponíveis#

    StatusDescrição
    activeEtapa ativa e funcional
    deactivatedEtapa desabilitada

    Casos de Uso Detalhados#

    1. Gestão de Pipelines#

    Cenário: Uma empresa deseja estruturar seu funil de vendas com etapas específicas.
    Fluxo:
    O usuário cria etapas como "Prospecção", "Proposta", "Fechamento".
    Associa campos personalizados a cada etapa.
    Move negociações entre etapas, acompanhando métricas como total de negociações e preço.
    Benefícios: Visibilidade do progresso das negociações e personalização do fluxo.

    Regras de Negócio#

    Criação de Etapas#

    Etapas são únicas por pipeline.
    Ordem definida automaticamente, mas ajustável.
    Vinculação automática à empresa do pipeline.

    Controle de Acesso#

    Usuários só podem gerenciar etapas de pipelines de sua empresa.
    Isolamento por empresa (multi-tenancy).
    Etapas desativadas não recebem novas negociações.

    Segurança#

    Exclusão de etapas exige movimentação de negociações associadas.
    Validação de campos personalizados obrigatórios ao mover negociações.

    Operações Disponíveis#

    OperaçãoDescriçãoMétodo HTTP
    ListarRecupera etapas com paginaçãoGET
    CriarCria uma nova etapaPOST
    VisualizarExibe detalhes de uma etapa específicaGET
    AtualizarModifica a etapa ou campos personalizadosPUT/PATCH
    ExcluirRemove uma etapaDELETE
    Mudança em MassaMove negociações entre etapasPOST

    Fluxo de Uso#

    Segurança e Boas Práticas#

    Para Desenvolvedores#

    Garantir validação de campos obrigatórios ao mover negociações.
    Usar transações para mudanças em massa.

    Para Usuários#

    Definir ordens lógicas para etapas.
    Usar cores de fundo para facilitar identificação visual.
    Verificar negociações antes de excluir etapas.

    Limitações e Restrições#

    Etapas são específicas por pipeline e empresa.
    Não é permitido excluir etapas com negociações ativas sem transferência.
    Página anterior
    Atualizar proposta
    Próxima página
    Buscar todos os estágios do funil pelo ID
    Built with