Skip to main content
Auth: TokenAccount or TokenInstance on every route. Each call validates the instance ownership. Communities are WhatsApp “parent groups” that bundle other groups as subgroups. This section covers the /api/community/* routes for creating, linking, unlinking, and listing subgroups. For regular groups, see Groups.

Endpoints

How it works

A WhatsApp community is composed of:
  • Parent group (the community itself), where you manage everything
  • Announcements group, created automatically. Only admins post, but every member of the subgroups receives the messages
  • Subgroups, regular groups linked to the community
Each group belongs to at most one community at a time. To move a group from one community to another, unlink first and then link to the destination.

Identifiers

  • Most routes expect JIDs @g.us in communityJid and groupJid.
  • GET /listSubGroups requires ?communityJid= in the query string.

Response shapes

/create response

On the /unlink endpoint, the field is named linked but contains the JIDs successfully unlinked (shared DTO). Use the message ("Unlinked N of M ...") to disambiguate.

/listSubGroups response

isDefaultSubGroup=true indicates the community’s default Announcements group.

Error envelope

Next

Create community

Create the parent group and link initial subgroups.

List subgroups

Return the linked groups.