WhatsApp — Syncro API

List connected WhatsApp numbers and approved official templates. Sending messages is done through the Leads endpoints.

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

List the connected WhatsApp numbers and the approved official templates. Sending messages is done through the Leads endpoints (links at the bottom of the page).

List connected numbers

GET/whatsapp/instances

Permission: whatsapp:read

Lists the connected WhatsApp numbers. No parameters.

Response fields

providerstringoptional

waha (unofficial) or cloud_api (official Meta API)

supports_templatesbooleanoptional

true if it accepts HSM templates (official API only)

has_window_restrictionbooleanoptional

true if it respects the 24h window (official API only)

idintegeroptional

Use as instance_id when sending messages

Request

curl "https://app.syncro.chat/api/v1/whatsapp/instances" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "provider": "waha",
      "display_name": "Número principal",
      "phone_number": "+5511999887766",
      "is_primary": true,
      "status": "connected",
      "supports_templates": false,
      "supports_buttons": false,
      "has_window_restriction": false
    },
    {
      "id": 2,
      "provider": "cloud_api",
      "display_name": "API Oficial",
      "phone_number": "+5521987654321",
      "is_primary": false,
      "status": "connected",
      "supports_templates": true,
      "supports_buttons": true,
      "has_window_restriction": true
    }
  ]
}

List templates (HSM)

GET/whatsapp/templates

Permission: whatsapp:read

Lists the account official (HSM) templates.

Query parameters

instance_idintegeroptional

Filters by number

statusstringoptional

APPROVED, PENDING, REJECTED, PAUSED, DISABLED

languagestringoptional

Template language (e.g.: pt_BR)

Use the template id in POST /leads/{id}/send-whatsapp-template, passing variables in the order of {{1}}, {{2}}...

Request

curl "https://app.syncro.chat/api/v1/whatsapp/templates?status=APPROVED" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "lembrete_proposta",
      "language": "pt_BR",
      "category": "UTILITY",
      "status": "APPROVED",
      "whatsapp_instance_id": 2,
      "variables": [
        "nome",
        "titulo",
        "data"
      ],
      "components": [
        {
          "type": "BODY",
          "text": "Olá {{1}}, sua {{2}} está agendada para {{3}}."
        }
      ],
      "quality_rating": "GREEN"
    }
  ]
}

Send messages

Sending is per lead:

Text/image: POST /leads/{id}/send-whatsapp
Template (HSM): POST /leads/{id}/send-whatsapp-template

Both require the whatsapp:write permission.