Skip to main content
POST
/
api
/
community
/
create
/
:instance
Create community
curl --request POST \
  --url https://api.example.com/api/community/create/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "groupJid": [
    "<string>"
  ],
  "membershipApprovalMode": "<string>"
}
'

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 • Rate-limit: Global (100/min) • Idempotent: no

​
Description

Creates a community (parent group with an automatic Announcements group). Optionally accepts a description, picture, and a list of existing groups to link during creation. Each link has a 1s delay between calls to avoid throttling from the WhatsApp server.
If the WhatsApp server rejects the creation as a parent (400), the service performs an automatic fallback to a regular group. The response comes back with isCommunity: false and a notice in message.

​
Examples

​
Minimum

Creates the community with only the required name (“Alpha Community”), with no description, picture, or subgroups linked in the call. 
curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alpha Community"
  }'

​
With subgroups

Creates the community “XYZ Company” with description, picture, and links 2 existing groups (groupJid) as subgroups, plus sets membershipApprovalMode: request_required so joins require approval. 
curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "XYZ Company",
    "description": "Official community",
    "image": "https://example.com/community.png",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ],
    "membershipApprovalMode": "request_required"
  }'

​
Success response

Returns the freshly created community in group, where group.jid is the community’s JID (use it as communityJid in subsequent calls) and isCommunity: true confirms WhatsApp accepted the creation as a parent group. Groups passed in groupJid are processed in order and split into linkedGroups (success) and failedGroups (failure). If an image was sent but failed to apply, the reason appears in imageError without aborting the creation.
200 OK
{
  "success": true,
  "message": "Community created successfully",
  "linkedGroups": ["120363406289005074@g.us"],
  "failedGroups": [],
  "imageError": "",
  "group": {
    "name": "Alpha Community",
    "jid": "120363406289005073@g.us",
    "description": "Official community",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 1,
    "participants": [
      { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": true }
    ],
    "isCommunity": true,
    "isParent": true
  }
}

​
Path parameters

​
instance
string
required
Instance name (e.g., $Instance_Name).

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json

​
Request body

​
name
string
required
Community name. Max 25 characters.
​
description
string
Community description.
​
image
string
URL or base64. Converted to JPEG. An image failure does not abort the creation, it is reported in imageError.
​
groupJid
string[]
List of @g.us JIDs of existing groups to link as subgroups.
​
membershipApprovalMode
string
request_required (subgroups require approval by default) or empty string (open).

​
Notes

  • The community is born with no participants, members join via each subgroup.
  • The Announcements group is created automatically by WhatsApp. You do not control its name / description here, use PUT /api/group/update afterwards to adjust it.
  • Limit of 50 subgroups per community (extras land in failedGroups).
  • imageError is populated when the picture fails but the community is still created normally.
  • Silent fallback to regular group: monitor isCommunity on the client side to alert the user.

​
Errors

HTTPMessage
400community name is required
400Community name must be 25 characters or less
400Instance is not connected to WhatsApp
429rate limit exceeded (429): wait before creating again
500failed to create community: <reason>
Envelope: 
{
  "success": false,
  "error": { "message": "community name is required" }
}

​
Next

Link groups

Add more subgroups after creation.

List subgroups

Check the currently linked groups.