API referenceGroups
Create a group
Create a WhatsApp group for the session.
Creates on WhatsApp and stores group info locally.
Errors: validation_error, not_found, not_implemented if session is disconnected.
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 creates the group.
Example
"01HZ0SESSION0000000000000"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name?string
Group subject. Required.
Example
"Engineering Team"participants?array<string>|
Initial member JIDs.
Example
[ "6281234567890@s.whatsapp.net", "6289876543210@s.whatsapp.net"]Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups" \ -H "Content-Type: application/json" \ -d '{}'{ "description": "string", "groupJid": "string", "isAnnounce": true, "isLocked": true, "ownerJid": "string", "participants": 0, "subject": "string"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}