Skip to main content
POST
/
api
/
community
/
unlink
/
:instance
Unlink groups
curl --request POST \
  --url https://api.example.com/api/community/unlink/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "communityJid": "<string>",
  "groupJid": [
    "<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

Unlinks groups from a community. The groups are not deleted, they simply become independent again (no linkedParentJid). Same body and response as /link (shared DTO).
The linked field in the response contains the JIDs successfully unlinked (because of the reuse of the CommunityLinkResponse DTO). The message ("Unlinked N of M ...") confirms the semantics.

​
Examples

Removes 2 subgroups from the community 120363406289005073@g.us. The groups become independent again (no linkedParentJid) but continue to exist with their members. 
curl -X POST "https://ryzeapi.cloud/api/community/unlink/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  }'

​
Success response

Confirms the unlink by returning the count in message (format "Unlinked N of M groups from community"). Because of the DTO shared with /link, the linked array here contains the JIDs successfully unlinked, and failed contains the ones that failed. success is true when at least one group was unlinked, even on partial success, always check failed[] to detect per-group errors.
200 OK
{
  "success": true,
  "message": "Unlinked 2 of 2 groups from community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

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

​
Request body

​
communityJid
string
required
Community @g.us JID.
​
groupJid
string[]
required
JIDs of the groups to unlink. At least 1 item.

​
Notes

  • The community’s Announcements group cannot be unlinked, to remove the announcement group, you must delete the entire community (not exposed in this API).
  • The members of the groups stay where they were, only the parent-child relationship is removed.
  • To move a group between communities, unlink it here and use /link on the new one.

​
Errors

HTTPMessage
400community jid is required
400group jid is required
400Instance is not connected to WhatsApp
500error parse community jid: <reason>
Envelope: 
{
  "success": false,
  "error": { "message": "community jid is required" }
}

​
Next

Link groups

Reconnect to another community.

List subgroups

Confirm the group has been removed.