Como inserir anotações no Lead por meio da API de Integração

Inserção de Anotações no Lead

Se você já utiliza integrações com o sistema, sabe como é importante manter o histórico dos leads sempre atualizado.

Agora, com a API de inserção de anotações, é possível registrar informações diretamente na timeline do Lead ou no log de integração, garantindo mais rastreabilidade e organização dos dados.

Essa funcionalidade permite que sistemas externos incluam observações automaticamente, centralizando todas as interações no Lead e facilitando o acompanhamento pela equipe.

Entenda melhor os itens da API

1. Autenticação

Antes de inserir uma anotação, é necessário gerar o token de acesso.

O endpoint /api/token será responsável por autenticar o usuário e fornecer o token que será utilizado nas requisições.

Parâmetros:

• grant_type: Tipo de autenticação (ex.: password)
• username: Nome de usuário
• password: Senha do usuário

2. Inserir Anotação no Lead

Após a autenticação, é possível registrar anotações utilizando o endpoint específico da funcionalidade.

Essa API permite incluir observações diretamente no histórico do Lead.

Campos relevantes

Tipo
Define onde a anotação será exibida:

• Timeline
• Log de Integração

Descrição da Anotação
Conteúdo que será registrado no Lead. Pode conter informações vindas de integrações ou observações relevantes para o acompanhamento.

Comportamento automático

Ao registrar uma anotação, o sistema realiza automaticamente:

• Associação com o usuário do token utilizado
• Registro da data e hora da inclusão

Essas informações garantem rastreabilidade e controle sobre as interações realizadas.

Parâmetros para integração

A API disponibiliza parâmetros completos para envio das informações necessárias, permitindo flexibilidade na integração com outros sistemas.

Recomenda-se validar os campos disponíveis diretamente na documentação técnica.

Dicas importantes

Centralize as informações no Lead
Utilize a API para registrar interações relevantes, mantendo o histórico sempre atualizado.

Diferencie os tipos de anotação
Use Timeline para interações visíveis ao time e Log de Integração para registros técnicos.

Consulte a documentação completa
Acesse o Swagger para verificar todos os endpoints, parâmetros e estruturas disponíveis.

Conclusão

A API de inserção de anotações no Lead permite registrar informações de forma automatizada, garantindo mais controle, organização e visibilidade sobre cada interação realizada.

Com isso, sua equipe ganha mais contexto para atuar e tomar decisões com base em um histórico completo e confiável.