Pular para o conteúdo principal
DELETE
/
api
/
instance
/
logout
/
:instance
Desconectar Instância
curl --request DELETE \
  --url https://api.example.com/api/instance/logout/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Desvincula o dispositivo do WhatsApp (como clicar em “Sair” no WhatsApp Web) e fecha o websocket. O registro da instância não é apagado, o token continua válido para um futuro connect (com novo QR).

​
Exemplo

Faz DELETE no path de logout para desvincular o dispositivo do WhatsApp e fechar o WebSocket. O registro da instância é preservado, então o mesmo token pode ser reutilizado em uma futura chamada de connect. 
curl -X DELETE "https://ryzeapi.cloud/api/instance/logout/minha-instancia" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Instance logged out",
  "instance": {
    "status": "loggedout"
  }
}

​
Path parameters

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Erros

HTTPerror.messageQuando
401Invalid tokenToken ausente ou inválido.
404Instance not foundNome não existe.
429Rate limit exceeded. Try again later.Mais de 100 req/min.
500Failed to logout instanceFalha interna.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Notas

Após logout, reconnect deixa de funcionar, a sessão whatsmeow é apagada. Use connect para gerar um novo QR.
Não apaga o registro da instância. Para remover completamente (incluindo configurações, webhook, dados), use DELETE /api/instance/delete/:instance.

​
Próximo

Conectar de novo

Gere um novo QR para vincular outro dispositivo.

Deletar instância

Para remover tudo definitivamente.