API referenceGroups
Add members to a group
Add member JIDs to a group.
Requires send, a connected session, and admin rights in the group. Returns 204 on success.
Errors: validation_error, not_found, forbidden, not_implemented.
AuthorizationBearer <token>
Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.
In: header
Path Parameters
session*string
WhatsApp session id that owns the group. Must be connected for this live action.
Example
"01HZ0SESSION0000000000000"gid*string
Group JID, usually ending in @g.us. Percent-encode reserved characters such as @ in the URL path.
Example
"120363041234567890@g.us"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
participants?array<string>|
User JIDs to add.
Example
[ "6281234567890@s.whatsapp.net"]Response Body
application/json
curl -X POST "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups/120363041234567890@g.us/members" \ -H "Content-Type: application/json" \ -d '{}'Empty
{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}