Cria uma instancia
Cria uma nova instancia (numero de WhatsApp) no Projeto da API key. A instancia nasce no estado DISCONNECTED, sem numero pareado (phoneNumber e jid nulos); para coloca-la online voce abre o QR Code em seguida (via qr/poll ou stream SSE) e escaneia no celular. O nome e apenas um rotulo e nao precisa ser unico — nomes podem repetir no mesmo Projeto. Sujeito a cota: cada Projeto so pode criar ate o numero de instancias do seu plano (numeros contratados); estourar a cota retorna 409. Criar instancia exige assinatura ativa (402 se nao houver). Retorna a instancia criada (201).
Authorization
bearerAuth API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/instances" \ -H "Content-Type: application/json" \ -d '{ "name": "minha-instancia" }'{
"id": "cm5x8a9k20001abc123def456",
"projectId": "cm5x000proj0001xyz",
"name": "minha-instancia",
"status": "DISCONNECTED",
"phoneNumber": null,
"jid": null,
"createdAt": "2026-05-30T12:00:00Z",
"updatedAt": "2026-05-30T12:00:00Z"
}{
"error": {
"code": "BAD_REQUEST",
"message": "Body invalido"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "PAYMENT_REQUIRED",
"message": "E necessario um plano ativo para usar este recurso. Assine em \"Meu plano\"."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "CONFLICT",
"message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
}
}