Skip to main content
Group endpoints require the connected WhatsApp account to have the right permissions in the target group.

Groups

EndpointBodyUse
GET /group/listnoneList groups joined by the account.
GET /group/myallnoneList groups where the account appears as owner/admin according to the handler logic.
POST /group/createGroupName, ParticipantsCreate a group and add initial participants.
POST /group/infoGroupJIDFetch group metadata.
POST /group/invitelinkGroupJID, ResetGet invite link, optionally reset it.
POST /group/updateGroupJID, ParticipantJID, ActionAdd, remove, promote, or demote participants.
POST /group/nameGroupJID, NameChange group subject.
POST /group/photoGroupJID, ImageSet JPEG group photo.
POST /group/descriptionGroupJID, DescriptionUpdate group topic/description.
POST /group/lockGroupJID, LockRestrict who can edit group info.
POST /group/adminonlyGroupJID, AdminOnlyRestrict sending messages to admins.
POST /group/joinCodeJoin a group using invite code/link.
POST /group/leaveGroupIdLeave a group.

Create group

{
  "GroupName": "Support",
  "Participants": ["15551234567", "15557654321"]
}
The response includes the group JID, owner, added participants, and failed participants.

Update participants

{
  "GroupJID": "[email protected]",
  "ParticipantJID": ["15551234567"],
  "Action": "add"
}
Common participant actions are add, remove, promote, and demote.

Communities

EndpointBodyUse
POST /community/createCommunityNameCreate a parent community group.
POST /community/addCommunityJID, GroupJIDLink groups into a community.
POST /community/removeCommunityJID, GroupJIDUnlink groups from a community.
Community add/remove accepts GroupJID as an array of group JID strings.