Skip to main content

Logout WhatsApp instance

POST /v1/numbers/{id}/logout disconnects a WhatsApp instance (logout) without removing it from the database. This is different from DELETE /v1/numbers/{id} which permanently removes the instance.
Response:

When to use it

  • When you want to disconnect a WhatsApp instance temporarily without deleting it.
  • When you need to reconnect a number to a different device.
  • When troubleshooting connection issues and need to reset the connection state.

Differences from DELETE

Request parameters

Response

Success (200)

Errors

Notes

  • The logout is best-effort: if the upstream provider returns a benign error (e.g., instance not found, 401), it is silently ignored and the instance state is still updated.
  • After logout, the instance state will be LOGOUT in the database.
  • You can reconnect the instance later using GET /v1/numbers/{id}/connect.