| POST | /get-groups | List groups |
| POST | /get-group-participants | Group details & members |
| POST | /create-group | Create a group |
| POST | /update-group-members | Add, remove, promote, demote |
| POST | /group-invite-link | Invite link |
| POST | /leave-group | Leave a group |
POST
/get-groupsList groups
All groups the linked number is a member of.
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
Request · JSON body
{ "clientId": "acmemain" }Response · 200
{ "groups": [ { "jid": "120363012345678901@g.us", "name": "Launch team", "participants": 14, "isAnnounce": false, "isLocked": false, "ownerJid": "60123456789@s.whatsapp.net" } ] }POST
/get-group-participantsGroup details & members
Full metadata plus the member list with admin flags.
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
groupJidrequired | string | …@g.us |
Request · JSON body
{ "clientId": "acmemain", "groupJid": "120363012345678901@g.us" }Response · 200
{ "group": { "jid": "…@g.us", "name": "Launch team", "topic": "Weekly sync", "addressingMode": "lid",
"members": [ { "jid": "123456789012345@lid", "phone": "60123456789", "isAdmin": true, "isSuperAdmin": false, "displayName": "Jane" } ] } }POST
/create-groupCreate a group
Creates the group with the linked number as owner and adds the participants.
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
subjectrequired | string | ≤ 25 characters. |
participantsrequired | string[] | LIDs, +phones or JIDs. |
Request · JSON body
{ "clientId": "acmemain", "subject": "Project Alpha", "participants": ["+60123456789", "123456789012345"] }Response · 200
{ "group": { "jid": "120363…@g.us", "name": "Project Alpha", "participants": 3, "…": "…" } }POST
/update-group-membersAdd, remove, promote, demote
Requires admin rights in the group.
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
groupJidrequired | string | |
actionrequired | "add" | "remove" | "promote" | "demote" | |
participantsrequired | string[] |
Request · JSON body
{ "clientId": "acmemain", "groupJid": "…@g.us", "action": "add", "participants": ["+60123456789"] }Response · 200
{ "members": [ { "jid": "123456789012345@lid", "error": 0 } ] }- A non-zero per-member
erroris WhatsApp's status code for that member (e.g. 403 = they only allow admins to add them; send them the invite link instead).
POST
/group-invite-linkInvite link
Get the current invite link, or reset: true to revoke it and issue a new one.
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
groupJidrequired | string | |
reset | boolean |
Request · JSON body
{ "clientId": "acmemain", "groupJid": "…@g.us" }Response · 200
{ "link": "https://chat.whatsapp.com/AbCdEfGh123" }POST
/leave-groupLeave a group
| Parameter | Type | Description |
|---|---|---|
clientIdrequired | string | Your account identifier (letters and digits only). |
groupJidrequired | string |
Request · JSON body
{ "clientId": "acmemain", "groupJid": "…@g.us" }Response · 200
{ "ok": true }