Introdução

Bem-vindo à API do Syncro. Integre o seu CRM a sites, formulários, automações (n8n, Make, Zapier), ERPs e sistemas próprios — crie e atualize leads, mova negócios no funil, gerencie tarefas, dispare mensagens de WhatsApp e receba eventos em tempo real via webhooks.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

O que você pode fazer

Leads e funil

Crie, atualize, busque, mova de etapa, marque como ganho ou perdido, aplique tags e inscreva em sequências.

Tarefas

Crie, liste, atualize e conclua tarefas, com ou sem lead vinculado.

Envie texto, imagem e templates oficiais (HSM) e liste números e templates aprovados.

Catálogo

Leia pipelines e etapas, campos personalizados e sequências de nutrição.

Webhooks

Assine eventos (lead criado, etapa alterada, venda, tarefa etc.) e receba-os na sua URL, com assinatura HMAC.

Fluxo básico de integração

Gere uma API Key no painel do Syncro, em Configurações → API Keys (veja Autenticação).
Faça chamadas para a API enviando o header X-API-Key com a sua chave.
Descubra os IDs que você vai usar: liste pipelines/etapas (GET /pipelines) e campos personalizados (GET /custom-fields).
Crie ou atualize leads (POST /leads ou POST /leads/upsert), crie tarefas, envie WhatsApp etc.
(Opcional) Assine webhooks (POST /webhooks) para receber eventos em tempo real no seu sistema.

Primeira requisição

Depois de gerar a sua chave, teste a conexão buscando os dados da sua conta:

curl https://app.syncro.chat/api/v1/account \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json"

Resposta esperada:

{
  "success": true,
  "account": { "id": 1, "name": "Minha Empresa", "plan": "scale" }
}

Próximo passo: Autenticação.