Skip to main content
DELETE
Logout Instance
Auth: TokenAccount or TokenInstanceRate-limit: Global (100/min) • Idempotent: yes

Description

Unlinks the device from WhatsApp (the equivalent of clicking “Log out” in WhatsApp Web) and closes the websocket. The instance record is not deleted, the token remains valid for a future connect (with a new QR).

Example

Sends a DELETE to the logout path to unlink the device from WhatsApp and close the WebSocket. The instance record is preserved, so the same token can be reused on a future call to connect.

Success response

200 OK

Path parameters

string
required
Instance name.

Headers

string
required
TokenAccount or TokenInstance.

Errors

Notes

After logout, reconnect no longer works, the whatsmeow session is wiped. Use connect to generate a new QR.
This does not delete the instance record. To remove it completely (including settings, webhooks, and data), use DELETE /api/instance/delete/:instance.

Next

Connect again

Generate a new QR to link another device.

Delete instance

To remove everything permanently.