groups
Group management
Create a new group
Create a new group
Preview a group from its invite code, without joining
Read-only: nothing about the account changes, which is what makes it safe to call on a code from an untrusted source. Supported on both engines.
Get detailed group info
Get detailed group info
Join a group via invite code
Join a group via invite code
Get group settings (announce / locked / ephemeral timer)
Get group settings (announce / locked / ephemeral timer)
Update group settings (announce / locked / ephemeral timer)
Update group settings (announce / locked / ephemeral timer)
Add participants to a group
Add participants to a group
Remove participants from a group
Remove participants from a group
Promote participants to admin
Promote participants to admin
Demote participants from admin
Demote participants from admin
List pending join requests for a group
The join-approval queue of a group the account administers (join-approval mode on). Admin-only on both engines — a non-admin read is refused. Fields the engine does not report are omitted rather than defaulted.
Approve pending join requests
Approves the named requesters, or EVERY pending request when the body names none. Approving an empty queue is a no-op that returns an empty results list. On whatsapp-web.js the engine pauses 250-500ms between requesters (upstream anti-abuse pacing), so acting on a large queue is a proportionally long request.
Reject pending join requests
Rejects the named requesters, or EVERY pending request when the body names none. Rejecting an empty queue is a no-op that returns an empty results list. On whatsapp-web.js the engine pauses 250-500ms between requesters (upstream anti-abuse pacing), so acting on a large queue is a proportionally long request.
Change group name/subject
Change group name/subject
Change group description
Change group description
Leave a group
Leave a group
Get the group's picture URL
Get the group's picture URL
Set the group's picture
Set the group's picture
Remove the group's picture
Remove the group's picture
Get group invite code/link
Get group invite code/link
Revoke group invite code and generate new one
Revoke group invite code and generate new one