Chats

Pin a chat

Pins a chat to the top of the list for the connected account via a WhatsApp app-state patch. No request body is required.

POST
/chats/{jid}/pin

Pins a chat to the top of the list for the connected account via a WhatsApp app-state patch. No request body is required.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

jid*string

Target chat JID (user or group).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/chats/5511999999999@s.whatsapp.net/pin"
{  "success": true,  "chat_jid": "5511999999999@s.whatsapp.net",  "pinned": true}
{  "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"}

Mute or unmute a chat POST

Mutes or unmutes a chat for the connected account via a WhatsApp app-state patch. When muting, an optional duration_seconds limits the mute window; omitting it mutes indefinitely.

Send typing indicator POST

Emits a typing or recording indicator inside a specific chat so the recipient sees the WUTS account composing a message.