Groups
Create and manage WhatsApp groups.
Endpoints (21)
Returns all WhatsApp groups the connected instance participates in. Group JID format: [email protected].
Create a new WhatsApp group with a subject and optional initial participants.
Join a group using an invite code or full invite link (chat.whatsapp.com/...).
Returns metadata and participants for a single group.
Update group subject (name) and/or description. Requires admin privileges.
Leave a group the instance is a member of.
Change group settings: announcement mode, edit permissions, member add mode, or join approval.
Get the current invite code and link for a group. Requires admin privileges.
Revoke the current invite link and generate a new one. Requires admin privileges.
Add one or more participants to a group.
Remove one or more participants from a group. Requires admin privileges.
Returns the public URL of the group profile picture, if set.
Set the group profile picture from a public image URL. Requires admin privileges.
Remove the group profile picture. Requires admin privileges.
Remove admin privileges from one or more group members.
Promote one or more group members to admin.
Send a group invite message to a contact via WhatsApp.
Preview group metadata before joining, using an invite code or link.
List pending join requests for groups with approval enabled. Requires admin privileges.
Approve pending join request(s) for the given participant(s).
Reject pending join request(s) for the given participant(s).