Set the tenant-wide proxy
Sets the proxy used by every instance of the tenant that does not have its own override. whatsmeow reads the proxy only when it dials, so the tenant's online instances are reconnected in the background to apply it immediately; offline instances pick it up on their next reconnect.
Sets the proxy used by every instance of the tenant that does not have its own override. whatsmeow reads the proxy only when it dials, so the tenant's online instances are reconnected in the background to apply it immediately; offline instances pick it up on their next reconnect.
Authorization
bearerAuth Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Payload for setting a tenant-wide or per-instance proxy.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/proxy" \ -H "Content-Type: application/json" \ -d '{ "proxy_url": "socks5://user:pass@proxy.example.com:1080" }'{ "success": true, "scope": "tenant", "proxy_url": "socks5://user:***@proxy.example.com:1080", "reconnecting_devices": 3}{ "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"}Set an instance proxy override PUT
Sets a proxy for a single instance. The override wins over the tenant-wide proxy. The instance is reconnected so it dials through the new proxy immediately.
List status privacy rules GET
Returns the configured status privacy rules for the connected WUTS WhatsApp session, including each rule type, whether it is the active default, and any contact JIDs attached to whitelist or blacklist rules.