Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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

MethodPathFunction
POST/api/community/create/:instanceCreate community
POST/api/community/link/:instanceLink groups to community
POST/api/community/unlink/:instanceUnlink groups
GET/api/community/listSubGroups/:instanceList subgroups

​
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

{
  "success": true,
  "message": "Community created successfully",
  "linkedGroups": ["120363406289005074@g.us"],
  "failedGroups": [],
  "imageError": null,
  "group": {
    "name": "Alpha Community",
    "jid": "120363406289005073@g.us",
    "isCommunity": true,
    "isParent": true,
    "linkedParentJid": null
  }
}

{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": ["120363406289005074@g.us", "120363406289005075@g.us"],
  "failed": []
}
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

{
  "success": true,
  "message": "2 subgroup(s) found",
  "communityJid": "120363406289005073@g.us",
  "subgroups": [
    { "jid": "120363406289005074@g.us", "name": "Announcements", "isDefaultSubGroup": true },
    { "jid": "120363406289005075@g.us", "name": "General", "isDefaultSubGroup": false }
  ]
}
isDefaultSubGroup=true indicates the community’s default Announcements group.

​
Error envelope

{
  "success": false,
  "error": { "message": "community jid is required" }
}

​
Next

Create community

Create the parent group and link initial subgroups.

List subgroups

Return the linked groups.