Generate pairing QR code
Generates a WhatsApp pairing QR code so the WUTS device can be linked by scanning. Returns a freshly cached QR by default; pass refresh flags to force regeneration. Refuses devices that are already paired or connected.
Generates a WhatsApp pairing QR code so the WUTS device can be linked by scanning. Returns a freshly cached QR by default; pass refresh flags to force regeneration. Refuses devices that are already paired or connected.
Authorization
bearerAuth Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.
In: header
Query Parameters
Target WUTS device identifier. When omitted, the device is resolved from the authenticated session.
When true, returns a still-valid cached QR code instead of regenerating. Aliases: reuse, use_cache, cached. Defaults to reusing the cache.
When true, forces a brand-new QR code and ignores the cache. Aliases: force_refresh, force_new.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/qr"{ "success": true, "data": { "qr_code": "2@aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789==,AbCdEf==", "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAB... ", "cached": false, "expires_at": "2026-06-15T18:30:45Z", "ttl": 60 }}{ "success": false, "error": "already connected"}{ "success": false, "error": "unauthorized"}{ "success": false, "error": "timeout waiting for QR code"}{ "success": false, "error": "failed to initialize device"}Generate phone pairing code POST
Generates an 8-character WhatsApp pairing code so the WUTS device can be linked by entering it on the phone instead of scanning a QR. Returns a cached code while it is still valid unless a refresh is requested.
Get instance send-health GET
Returns the derived **send health** of a device (WhatsApp instance) over a rolling 24-hour window, computed from the instance's real send outcomes. It surfaces WhatsApp's **reach-out time-lock**: when `restricted` is `true` (with `restriction: "reachout_timelock"`), WhatsApp is blocking this number's messages to new/cold contacts — common on new or recently re-created numbers. `available` is `false` when there is no send activity yet in the window. The device must belong to the authenticated token; ownership is enforced.