Meowsapp WhatsApp API
Documentation menu

Start here

Guides

API reference

More

API reference

Groups

List, inspect, create and manage groups. To receive group messages enable them per session with `/set-enable-group-ai`. Send to a group with `to: "<groupId>@g.us"` on any send route.

POST/get-groupsList groups
POST/get-group-participantsGroup details & members
POST/create-groupCreate a group
POST/update-group-membersAdd, remove, promote, demote
POST/group-invite-linkInvite link
POST/leave-groupLeave a group
POST/get-groups

List groups

All groups the linked number is a member of.

ParameterTypeDescription
clientIdrequiredstringYour account identifier (letters and digits only).
Request · JSON body
{ "clientId": "acmemain" }
Response · 200
{ "groups": [ { "jid": "[email protected]", "name": "Launch team", "participants": 14, "isAnnounce": false, "isLocked": false, "ownerJid": "[email protected]" } ] }
POST/get-group-participants

Group details & members

Full metadata plus the member list with admin flags.

ParameterTypeDescription
clientIdrequiredstringYour account identifier (letters and digits only).
groupJidrequiredstring…@g.us
Request · JSON body
{ "clientId": "acmemain", "groupJid": "[email protected]" }
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-group

Create a group

Creates the group with the linked number as owner and adds the participants.

ParameterTypeDescription
clientIdrequiredstringYour account identifier (letters and digits only).
subjectrequiredstring≤ 25 characters.
participantsrequiredstring[]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-members

Add, remove, promote, demote

Requires admin rights in the group.

ParameterTypeDescription
clientIdrequiredstringYour account identifier (letters and digits only).
groupJidrequiredstring
actionrequired"add" | "remove" | "promote" | "demote"
participantsrequiredstring[]
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 error is WhatsApp's status code for that member (e.g. 403 = they only allow admins to add them; send them the invite link instead).
POST/leave-group

Leave a group

ParameterTypeDescription
clientIdrequiredstringYour account identifier (letters and digits only).
groupJidrequiredstring
Request · JSON body
{ "clientId": "acmemain", "groupJid": "…@g.us" }
Response · 200
{ "ok": true }