Skip to main content
POST /v1/instances Cria uma nova instância do WhatsApp. Após a criação, vincule um número de telefone escaneando o QR code.

​
Requisição

​
Cabeçalhos

CabeçalhoValor
AuthorizationBearer <token>
Content-Typeapplication/json

​
Corpo

CampoTipoObrigatórioDescrição
namestringSimUm rótulo para esta instância
metadataobjectNãoMetadados arbitrários em chave-valor
{
  "name": "sales-team-a",
  "metadata": {
    "region": "us-east"
  }
}

​
Resposta 201

Retorna o objeto da instância criada.
CampoTipoDescrição
idstringID único da instância (prefixo inst_)
namestringRótulo da instância
statusstringSempre CREATED na criação
metadataobjectMetadados fornecidos
created_atstringTimestamp ISO 8601
updated_atstringTimestamp ISO 8601
{
  "id": "inst_abc123",
  "name": "sales-team-a",
  "status": "CREATED",
  "metadata": { "region": "us-east" },
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-01T10:00:00Z"
}

​
Erros

CódigoDescrição
400name está ausente
401Token ausente ou inválido

​
Exemplo

curl -X POST https://cawme.com/api/v1/instances \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sales-team-a",
    "metadata": { "region": "us-east" }
  }'