Chaves de API
Este é o passo a passo de dentro do WM CRM. Ainda não tem conta? Conheça os planos.
Chaves de API
As chaves de API permitem que outro sistema (seu site, uma landing page, uma automação) envie leads direto para o WM CRM. Fica em Configurações → Integrações → Chaves de API e é tarefa do gestor. O recurso depende do plano: sem ele, a tela mostra a opção de upgrade.
Criar uma chave
- Clique em Nova chave.
- Dê um nome (ex.: "Integração do site").
- Escolha a origem e o pipeline de destino: todo lead enviado por essa chave entra nessa origem e nesse pipeline.
- Clique em Criar chave.
A chave é exibida uma única vez, logo após a criação. Copie e guarde em local seguro — depois disso ela não aparece mais.
Usar a chave
Envie cada lead com uma requisição POST para /v1/leads, com a chave no cabeçalho:
Authorization: Bearer wmk_live_...
O corpo é um JSON com os dados do lead:
- name — nome (obrigatório)
- email — e-mail
- phone — telefone (apenas dígitos, com DDD)
- company — empresa
- value — valor estimado (número)
- externalId — o seu identificador daquele envio (opcional; veja abaixo)
- mensagem — o que a pessoa escreveu no formulário (opcional; veja abaixo)
- customFields — campos personalizados, no formato
{ "fieldId": "...", "value": "..." }
externalId: não duplicar o mesmo lead
Se o seu site ou a sua automação reenviar a mesma submissão — um retry depois de uma queda de rede, por exemplo —, sem externalId isso vira dois leads.
Mande em externalId um identificador seu daquele envio (o id da submissão do formulário, o id da execução da automação). Na primeira vez a API responde 201 e cria o lead. Em qualquer reenvio com o mesmo externalId, ela responde 200 com o mesmo lead, sem criar outro.
O externalId é único por conta e vale até 255 caracteres. Um lead que foi para a lixeira continua ocupando o seu externalId.
mensagem: o texto que a pessoa escreveu
Use mensagem para o campo livre do seu formulário ("Como podemos ajudar?"). O texto vai para as observações do lead e vira uma nota na timeline, marcada como vinda do formulário do site — então o vendedor lê o pedido junto com o resto do histórico.
Cabe até 2.000 caracteres. Num reenvio com o mesmo externalId a mensagem entra como nota nova; se for idêntica a uma já registrada, é ignorada — um retry não vira timeline repetida.
Onde achar o fieldId
O fieldId é o ID do campo personalizado. Abra Configurações → Leads → Campos, clique no lápis do campo e, no fim do modal Editar campo, está o bloco ID para integração (API) — com botão de copiar. Esse ID não muda quando você renomeia o campo, troca o tipo ou muda a aba.
A origem e o pipeline vêm sempre da chave — não os envie no corpo. O lead entra na primeira etapa do pipeline.
Gerenciar
A lista mostra cada chave com o status (ativa ou revogada), o prefixo (o restante fica oculto) e quando foi usada pela última vez. Para desativar uma chave, use Revogar — a ação é definitiva e não pode ser desfeita; se precisar, crie uma nova.
Disponível em: as chaves de API fazem parte dos planos Solo Max e Enterprise. Consulte a página de planos.