Desconectar
POST/connections/{id}/disconnect
Fecha o socket da conexão com o WhatsApp e mantém a sessão: o número continua pareado e a conexão volta sem QR code quando for conectada de novo. Enquanto isso ela não reconecta sozinha. Escopo necessário: connections:write.
Parâmetros de caminho
idstring · uuidobrigatórioIdentificador da conexão (o número).
Respostas
| Código | Erro e descrição |
|---|---|
| 200 | A conexão foi fechada, com a sessão preservada: {"ok": true}. |
| 400 | FST_ERR_VALIDATIONA requisição não segue o schema da operação (por exemplo, um id que não é um UUID); message diz o que está errado. |
| 401 | Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. O corpo é {"error": "Unauthorized"}. |
| 403 | A chave não tem o escopo connections:write; a mensagem de erro cita o escopo que falta. |
| 404 | A conexão não existe ou não é de quem chama: a de outra pessoa responde exatamente como uma que não existe (Connection not found). Também quando a conexão não está rodando (já desconectada, depois de um logout) ou quando o fechamento falhou. |
| 429 | Requisições demais deste IP de origem, ou autenticações com falha demais: espere os segundos de Retry-After.Cabeçalho: Retry-After |
| 503 | A instância do gateway que roda a conexão está mudando (um reinício, um failover) ou não responde: espere os segundos de Retry-After e tente de novo.Cabeçalho: Retry-After |
Detalhes
O webhook connection.status avisa o fechamento com status: close, reason: manual e willReconnect: false.
Para voltar a usar o número, conecte de novo com POST /tenants/{id}/connections/{connId}/connect. Para desligar o número de vez, e poder parear outro, use POST /connections/{id}/logout.
Funciona mesmo quando a organização não está em dia com o pagamento: desconectar só reduz o uso, então não responde 402.
Guia: Projetos e conexões
Esta página ajudou? · Atualizado em 28 set 2026