Conectar Instância

Gera o QR Code ou inicia o processo de pareamento para conectar a instância ao WhatsApp.

POST /instances/{instance_id}/connect

A conexão requer a leitura do QR Code pelo WhatsApp no celular do cliente. O QR Code expira em 40 segundos e é atualizado automaticamente.

Headers

Authorization string header required 06/04/2026

Token no formato Bearer <token_empresa>.

Query Parameters

instance_id string (uuid) path required 06/04/2026

ID único da instância (UUIDv7) enviado no caminho da URL.

Response Schema

application/json

success boolean required 06/04/2026

Indica se a requisição obteve sucesso.

error string | null required 06/04/2026

Mensagem de erro caso success seja falso.

data object | null required 06/04/2026

Dados de conexão da instância (pode ser null em alguns casos).

Atributos do Objeto

status string 06/04/2026

Status do processo de conexão. Retorna "CONNECTING".

message string 06/04/2026

Instrução para aguardar o recebimento do QR Code de forma assíncrona por meio do Webhook.

{
  "success": true,
  "data": {
    "status": "CONNECTING",
    "message": "Instrução enviada. Aguarde o recebimento do QR Code via Webhook."
  },
  "error": null
}

{
  "success": false,
  "data": null,
  "error": "Token de acesso inválido ou ausente."
}

{
  "success": false,
  "data": null,
  "error": "Instância não encontrada."
}