Groups

Remove group participants

Removes participants from a WhatsApp group. The default action is remove, but an explicit action (add, remove, promote, demote) may be supplied in the body to override it. Returns the per-participant result from WUTS.

DELETE
/groups/{jid}/participants

Removes participants from a WhatsApp group. The default action is remove, but an explicit action (add, remove, promote, demote) may be supplied in the body to override it. Returns the per-participant result 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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/groups/string/participants" \  -H "Content-Type: application/json" \  -d '{    "participants": [      "5511888888888@s.whatsapp.net"    ]  }'
{  "success": true,  "participants": [    {      "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"}

Remove community participants DELETE

Removes one or more participants from a community. Uses the same WhatsApp participant mechanism as regular groups, applied to the community parent JID.

Reset group invite link POST

Regenerates (revokes and reissues) the WhatsApp invite link for a group via WUTS, invalidating the previous link, and returns the new link with the reset timestamp.