Skip to main content

Como Criar e Usar Atributos Personalizados no Messages

O Messages permite que você acompanhe informações adicionais sobre suas conversas e contatos além dos atributos de dados padrão, como nome, e-mail e localização. Essas informações adicionais são chamadas de atributos customizados e podem ser qualquer coisa que você queira rastrear. Abaixo estão alguns exemplos de atributos customizados.

  • Plano de assinatura

  • Data da assinatura

  • Data de cadastro

  • Item mais comprado

  • Link do produto comprado

  • Data da última transação

Os atributos de dados customizados permitem que você anexe informações adicionais a uma conversa ou cliente, como histórico de compras ou status da conta. Essas informações podem ser usadas para compreender melhor e segmentar sua base de clientes.

A única diferença entre os atributos customizados e os atributos padrão é que os atributos padrão são atualizados automaticamente.

## Como criar um atributo customizado?

Passo 1. Vá para Configurações → Atributos Customizados. Clique no botão “Adicionar Atributo Customizado”.

Passo 2. Uma janela modal será aberta, solicitando os detalhes do novo atributo customizado. Preencha essas informações. Aqui está um exemplo:

Estes são os campos necessários para criar o atributo customizado:

  1. Aplica-se a

    Tipo do atributo (Conversa/Contato).

  2. Nome para exibição

    Serve como rótulo ao exibir o atributo customizado.

  3. Chave

    Identificador único associado ao atributo customizado.

  4. Descrição

    Descrição do atributo customizado.

  5. Tipo

    Texto, Número, Link, Data, Lista e Caixa de seleção.

Atenção: Não é possível criar um atributo customizado com a mesma chave mais de uma vez na conta.

Passo 3. Depois de inserir os detalhes, clique no botão “Criar”. Se a operação for bem-sucedida, a mensagem "Atributo customizado adicionado com sucesso" será exibida.

## Como usar um atributo customizado em uma conversa?

Você pode adicionar atributos customizados de conversa em uma conversa pelo painel lateral da conversa. Siga os passos abaixo.

Passo 1. No seu painel, ao abrir uma conversa específica, você encontrará uma seção chamada “Informações da Conversa”. Clique no sinal de + para expandi-la.

Passo 2. Você verá uma opção “Adicionar Atributos” seguida de um menu suspenso com todos os atributos customizados da sua conta. Use a barra de pesquisa para filtrar pelo nome do atributo desejado ou clique em um para selecioná-lo. Se precisar criar um novo, use o botão “Criar novo atributo” no mesmo menu.

Passo 3. Baseado no tipo do atributo adicionado (lista, caixa de seleção, texto, etc.), preencha conforme desejar. Aqui estão alguns exemplos:

Para editar/excluir/copiar um atributo, passe o mouse sobre ele para ver as opções.

## Como usar um atributo customizado em um contato?

Existem duas formas de definir atributos customizados para contatos.

### Definir atributos via método SDK

Para definir um atributo customizado de contato, chame o método setCustomAttributes da seguinte forma.

window.$chatwoot.setCustomAttributes({
  key: value,
  // Key é o identificador único que já foi definido ao criar um atributo customizado
  // Value deve ser compatível com o tipo (atualmente suporta Number, Date, String e Number)
  // Verifique se suas chaves sempre possuem um valor JSON válido
  // Você precisa "achatar" a estrutura JSON aninhada ao usar esta função
});

Exemplo:

window.$chatwoot.setCustomAttributes({
  key: value,
  // Key é o identificador único que já foi definido ao criar um atributo customizado
  // Value deve ser compatível com o tipo (atualmente suporta Number, Date, String e Number)
  // Verifique se suas chaves sempre possuem um valor JSON válido
  // Você precisa "achatar" a estrutura JSON aninhada ao usar esta função
});

Você pode visualizar esses atributos no painel lateral do contato/conversa.

Para excluir um atributo customizado, use deleteCustomAttribute da seguinte forma.

window.$chatwoot.deleteCustomAttribute("attribute-key");

Exemplo:

window.$chatwoot.deleteCustomAttribute("signUpDate");

Atenção: Antes da versão v1.22, todos os atributos eram exibidos como texto. Por favor, crie uma nova definição para exibir o valor corretamente.

### Definir atributos via painel lateral do contato

Para adicionar atributos ao contato, siga o mesmo procedimento descrito acima para os atributos customizados da conversa, porém use a seção Atributos do Contato no painel lateral do chat. Veja como fica:

Baseado no tipo do atributo adicionado (lista, caixa de seleção, texto, etc.), preencha conforme desejar. Aqui está um exemplo:

Back to top