Introduction

Welcome to the Syncro API. Integrate your CRM with websites, forms, automations (n8n, Make, Zapier), ERPs and your own systems — create and update leads, move deals through the pipeline, manage tasks, send WhatsApp messages and receive real-time events via webhooks.

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

What you can do

Leads & pipeline

Create, update, fetch, move stages, mark as won or lost, apply tags and enroll in sequences.

Tasks

Create, list, update and complete tasks, with or without a linked lead.

Send text, images and official templates (HSM) and list connected numbers and approved templates.

Catalog

Read pipelines and stages, custom fields and nurture sequences.

Webhooks

Subscribe to events (lead created, stage changed, sale, task, etc.) and receive them at your URL, with HMAC signature.

Basic integration flow

Generate an API Key in the Syncro panel, under Settings → API Keys (see Authentication).
Make calls to the API sending the X-API-Key header with your key.
Find the IDs you will use: list pipelines/stages (GET /pipelines) and custom fields (GET /custom-fields).
Create or update leads (POST /leads or POST /leads/upsert), create tasks, send WhatsApp, etc.
(Optional) Subscribe to webhooks (POST /webhooks) to receive real-time events in your system.

First request

After generating your key, test the connection by fetching your account data:

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

Expected response:

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

Next step: Authentication.