Groups

Create a group

Creates a new WhatsApp group with the given name and participants. Optional flags configure announcement mode, locking, join approval, and community linkage through the WUTS gateway.

POST
/groups

Creates a new WhatsApp group with the given name and participants. Optional flags configure announcement mode, locking, join approval, and community linkage through the WUTS gateway.

Authorization

bearerAuth
AuthorizationBearer <token>

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "WUTS Launch",    "participants": [      "5511999999999@s.whatsapp.net",      "5511888888888@s.whatsapp.net"    ],    "options": {      "announcement": false,      "locked": false,      "join_approval": true,      "community": false    }  }'
{  "success": true,  "group": {    "jid": "120363039000000000@g.us",    "name": "WUTS Launch",    "owner": "5511999999999@s.whatsapp.net",    "created_at": "2026-06-15T10:00:00Z",    "is_announce": false,    "is_locked": false,    "join_approval": true,    "members_count": 2,    "participants": [      {        "jid": "5511999999999@s.whatsapp.net",        "phone_number": "5511999999999@s.whatsapp.net",        "is_admin": true,        "is_super_admin": true      },      {        "jid": "5511888888888@s.whatsapp.net",        "phone_number": "5511888888888@s.whatsapp.net",        "is_admin": false,        "is_super_admin": false      }    ]  }}
{  "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"}

Create a community POST

Creates a WhatsApp community (a parent group). The linked announcement group is created automatically by the server. Participants are optional, so a community can be created solo.

Get group info GET

Returns the current information for a single WhatsApp group, including announce status, lock status, and the full participant list, via the WUTS gateway.