Boas-vindas

Plano e chave API

Precisa de plano ativo (Basic, Pro ou Time) para chamar a API e gerir aplicativos. Em Configurações → Para desenvolvedores, crie um app e gere a chave.

403 subscription_required — sem plano na conta.

instance_id e credenciais

Envie Authorization: Bearer … ou X-Coreli-Api-Key, mais X-Coreli-User-Token (crlu_…) e X-Coreli-Developer-App-Id com o UUID do aplicativo (Configurações → Para desenvolvedores).

Cada instance_id está no painel em Configurações do canal (campo API pública — instance_id), para copiar sem listagem por API.

• GET /api/v1/contacts — chats por instance_id. Ver Contatos.
• GET /api/v1/groups — grupos WhatsApp por instance_id. Ver Grupos.
• POST /api/v1/messages — envia texto aos contatos pela instance_id. Ver Mensagens.
• Oportunidades
  • Criar — POST /api/v1/opportunities.
  • Atualizar — PATCH /api/v1/opportunities/{id} (ganho/perda e campos).
  • Excluir — DELETE /api/v1/opportunities/{id}.
• Agenda
  • Criar — POST /api/v1/calendar/events.
  • Atualizar — PATCH /api/v1/calendar/events/{id}.
  • Excluir — DELETE /api/v1/calendar/events/{id}.

MCP

Conecte IDEs e agentes à documentação via servidor MCP remoto.

Ver clientes MCP · Cursor (instalação em um clique)

Integrações

Cursor, extensão gratuita para WhatsApp Web com Kanban, Tintim e outras conexões.

Ver integrações · Cursor · Extensão gratuita para WhatsApp

O que a API oferece

• Contatos — GET /api/v1/contacts (alias /chats), lista por instance_id com o mesmo payload da sidebar (wa_lastMessageStatus, lastMessage, paginação padrão 50).
• Grupos — GET /api/v1/groups, lista grupos com wa_chatid para envio via chat_id.
• Mensagens — POST /api/v1/messages, envia texto no WhatsApp (contato: phone; grupo: chat_id com @g.us).
• Oportunidades
  • Criar — POST /api/v1/opportunities.
  • Atualizar — PATCH /api/v1/opportunities/{id}.
  • Excluir — DELETE ….
• Agenda
  • Criar — POST /api/v1/calendar/events.
  • Atualizar — PATCH /api/v1/calendar/events/{id}.
  • Excluir — DELETE ….

Resumo dos caminhos: visão geral da API.