Add group participants
Adds participants to a WhatsApp group. The default action is add, but an explicit action (add, remove, promote, demote) may be supplied in the body to override it. Returns the per-participant result from WUTS.
Adds participants to a WhatsApp group. The default action is add, 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 Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.
In: header
Path Parameters
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 POST "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"}Add community participants POST
Adds one or more participants to a community. Community membership is managed at the parent-group level using the same WhatsApp participant mechanism as regular groups.
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.