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

    Template

    Entidade: Template#

    Visão Geral#

    A entidade Template representa modelos de mensagens ou documentos usados para automação de comunicações, como mensagens de WhatsApp, vinculados a pipelines e empresas.

    Estrutura da Entidade#

    Campos Principais#

    CampoTipoDescriçãoObrigatório
    idnumberIdentificador único do template✅ (auto)
    namestringNome descritivo do template✅
    pipeIdnumberID do pipeline associado✅
    companyIdnumberID da empresa proprietária (via pipeline)✅ (auto)
    createdAtDateTimeData/hora de criação✅ (auto)
    updatedAtDateTimeData/hora da última atualização✅ (auto)

    Relacionamentos#

    Pipe: Vinculado a um pipeline específico.
    Company: Vinculada à empresa do usuário (via pipeline).
    Activity: Utilizado em atividades, como envio de mensagens.

    Status Disponíveis#

    StatusDescrição
    activeTemplate ativo e funcional
    deactivatedTemplate desabilitado

    Casos de Uso Detalhados#

    1. Automação de Mensagens#

    Cenário: Uma empresa deseja enviar mensagens automáticas de WhatsApp para negociações em um pipeline.
    Fluxo:
    O usuário cria um template com placeholders para personalização.
    O template é associado a um pipeline específico.
    O sistema preenche variáveis dinâmicas (ex.: nome do cliente) e cria uma atividade de WhatsApp.
    Benefícios: Agilidade na comunicação e personalização de mensagens.

    Regras de Negócio#

    Criação de Templates#

    Templates são únicos por pipeline.
    Vinculação automática à empresa do pipeline.
    Status inicial definido como active.

    Controle de Acesso#

    Usuários só podem gerenciar templates de pipelines de sua empresa.
    Isolamento por empresa (multi-tenancy).
    Templates desativados não são usados em automações.

    Segurança#

    Validação de placeholders para evitar erros de formatação.
    Exclusão de templates não afeta atividades já criadas.

    Operações Disponíveis#

    OperaçãoDescriçãoMétodo HTTP
    ListarRecupera templates com paginaçãoGET
    CriarCria um novo templatePOST
    VisualizarExibe detalhes de um template específicoGET
    AtualizarModifica o templatePUT/PATCH
    ExcluirRemove um templateDELETE
    PreencherPreenche template com dados da negociaçãoPOST

    Fluxo de Uso#

    Segurança e Boas Práticas#

    Para Desenvolvedores#

    Garantir validação de placeholders para evitar erros de substituição.
    Usar transações para criar atividades associadas.

    Para Usuários#

    Usar nomes descritivos para templates.
    Testar templates antes de usar em automações.
    Desativar templates não utilizados.

    Limitações e Restrições#

    Templates são específicos por pipeline e empresa.
    Não suportam edição direta de atividades geradas.
    Página anterior
    Excluir estágio
    Próxima página
    Listar todos os templates de mensagem
    Built with