Referência da API - Ciarem

Cada endpoint abaixo é gerado a partir do contrato em produção, então o que você lê aqui é o que a API serve. URL base https://api.ciarem.ai · Autenticação Authorization: Bearer oak_… em toda solicitação (como obter uma chave).

Como está organizada

Grupo	O que tem nele
Account	A quem a chave pertence — organização, plano, fuso horário, idioma.
Contacts	Pessoas no seu CRM. CRUD completo.
CRM	O formato do seu CRM: propriedades personalizadas e etapas do funil.
Conversations	Ler o histórico de mensagens.
WhatsApp numbers	Os números de onde um envio pode sair.
WhatsApp templates	Seus modelos, e o que cada um precisa preenchido antes de poder ser enviado.
Broadcasts	Envie um modelo e acompanhe o que aconteceu com cada destinatário.

Por onde começar

Envie sua primeira mensagem

Consulte primeiro send-requirements, depois envie para um destinatário ou cem em uma única chamada.

Erros, limites e paginação

O vocabulário de erros, os cabeçalhos de limite de uso e como repetir com segurança.

A API é nova e avança rápido. As mudanças são aditivas — novos endpoints, novos parâmetros opcionais, novos campos de resposta e novos valores de texto — então tolere campos desconhecidos em vez de validar estritamente. Tudo que muda aparece no changelog.