Instances

Log out the instance

Performs a full logout: clears the stored WhatsApp credentials and removes the companion device server-side. Unlike POST /disconnect (which only drops the socket and keeps credentials), the instance must be re-paired (QR or pairing code) before it can connect again. Requires a live connection.

POST
/logout

Performs a full logout: clears the stored WhatsApp credentials and removes the companion device server-side. Unlike POST /disconnect (which only drops the socket and keeps credentials), the instance must be re-paired (QR or pairing code) before it can connect again. Requires a live connection.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/logout"
{  "success": true,  "data": {    "message": "device logged out successfully",    "device_id": "demo-device"  }}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}

List my devices GET

Returns every WUTS device (WhatsApp instance) registered to the authenticated user. The user is resolved from the bearer token, so no parameters are required.

Set the account profile picture POST

Updates the connected WhatsApp account's own profile photo. The image must be a base64-encoded JPEG; it replaces the current picture and returns the new picture ID.