API de contatos

Conseguimos criar contatos (POST), buscar vários contatos (GET), buscar um contato pelo seu id (GET) e editar um contato (PATCH).

Alteração, busca e criação de contatos

Url da documentação:

https://enterprise-40api.seu_dominio.com.br/v1/contacts/docs#

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:

https://enterprise-40api.seu_dominio.com.br/v1/contacts/

https://enterprise-40api.seu_dominio.com.br/v1/contacts/id_contato

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:

{
    "Authorization": "Bearer token"
}

O token é gerado quando você cria seu PUSH:

Atualizações 15/01/2025

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:

{
  "name": "string",
  "email": "string",
  "number": "string",
  "customFields": "{ 'field1': 'value1', 'field2': 'value2' }",
  "tags": [
    "string"
  ]
}

Ou pode ser utilizado dessa forma:

{
"customFields": "{ 'field1': 'value1', 'field2': 'value2' }",
  "tags": [
    "string"
  ]
}

Alterar, adicionar ou deletar campos customizados

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.

1

Faça uma requisição anterior

Busque primeiro o contato via API, através do ID ou do número de WhatsAPP

2

Vefique os campos customizados atuais

Veja quais campos já existem, adicione todos na requisição PATCH e altere apenas o valor que você quer adicionar

Você pode passar apenas o item customFields na requisição:

{
    "customFields": "{ 'field1': 'value1', 'field2': 'value2' }"
}

Para zerar todos os valores dos Campos Customizados é só fazer isso:

"customFields": "{}"

Alterar, adicionar ou deletar campos etiquetas

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:

{
    "tags": ["VIP", "Indicação"]
}

E para zerar as etiquetas é só deixar o array vazio:

{
    "tags": []
}

Buscar contatos por número de WhatsAPP

Forma antiga que está mantida (BUSCA POR ID)

https://enterprise-40api.seu_dominio.com.br/v1/contacts/id_contato

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.

https://enterprise-40api.seu_dominio.com.br/v1/contacts/number/numero_whatsapp

O numero_whatsapp precisa estar com o DDI e DDD, sem espaços e sem caracteres especiais. Ex.: 558495588745