Groups

Update group properties

Updates one or more mutable group properties (name, topic, description, announce mode, lock, join approval, member-add mode). At least one field must be supplied. Returns the refreshed group info from WUTS.

PATCH
/groups/{jid}

Updates one or more mutable group properties (name, topic, description, announce mode, lock, join approval, member-add mode). At least one field must be supplied. Returns the refreshed group info from WUTS.

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

Group JID (e.g. 120363039000000000@g.us).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Mutable group properties. At least one field must be supplied.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/groups/string" \  -H "Content-Type: application/json" \  -d '{    "name": "WUTS Team Renamed",    "topic": "New subject text",    "announcement": true,    "member_add_mode": "admin"  }'
{  "success": true,  "group": {    "jid": "120363039000000000@g.us",    "name": "WUTS Team Renamed",    "topic": "New subject text",    "owner": "5511999999999@s.whatsapp.net",    "created_at": "2026-01-10T14:22:00Z",    "is_announce": true,    "is_locked": false,    "join_approval": false,    "members_count": 2  }}
{  "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"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}

Unlink a group from a community DELETE

Removes a child group from a WhatsApp community. The path JID is the community (parent) JID and the body carries the child group JID to be unlinked.

Check connection status GET

Returns the live connection and login state of the WUTS device, including its WhatsApp JID and phone number once paired. Always responds 200; the connection details live in the data object.