API de contatos
Last updated
Last updated
Conseguimos criar contatos (POST), buscar vários contatos (GET), buscar um contato pelo seu id (GET) e editar um contato (PATCH).
Url da documentação:
Lembrando que o número 40 tem que ser alterado para o número do seu servidor e o seu_dominio deve ser alterado pelo nome que consta na url do seu sistema.
Os endpoints vão ser esses:
Caso seja necessário, temos a variável {{id}} que pegar o valor do id do contato.
Esses endpoints vão precisa de um cabeçalho:
O token é gerado quando você cria seu PUSH:
Com a nova atualização, vamos conseguir alterar, deletar ou adicionar campos customizados e/ou etiquetas. Outro ponto é uma rota para buscar clientes por número de WHATSAPP (antes só era feito através do id do cliente).
Antes de explicar cada ponto, segue o payload completo do método PATCH:
Ou pode ser utilizado dessa forma:
Vamos supor que o cliente tem 3 campos customizados e apenas o cpf_cliente está preenchido:
Se for feita uma requisição para adicionar o campo nome_cliente, o campo cpf_cliente vai ser apagado e vai aparecer o valor do campo nome_cliente.
Mas se eu quiser adicionar ou alterar apenas um campo, como eu faço? Pois quero manter os antigos e alterar/adicionar apenas um campo.
Você pode passar apenas o item customFields na requisição:
Para zerar todos os valores dos Campos Customizados é só fazer isso:
Diferente dos Campos Customizados, se você adiciona apenas uma etiqueta, as que já estavam vinculadas ao cliente não vão ser deletadas. Você também pode adicionar apenas o item tags no payload:
E para zerar as etiquetas é só deixar o array vazio:
Forma antiga que está mantida (BUSCA POR ID)
Só que quando precisamos buscar esse contato externamente, é complicado, pois é necessário buscar ele através do id do cliente no nosso sistema. Para resolver essa situação foi criado um recurso novo no endpoint para buscar clientes por número de WhatsApp.
O numero_whatsapp precisa estar com o DDI e DDD, sem espaços e sem caracteres especiais. Ex.: 558495588745