Link groups

POST

api

community

link

:instance

Link groups

curl --request POST \
  --url https://api.example.com/api/community/link/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "communityJid": "<string>",
  "groupJid": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({communityJid: '<string>', groupJid: ['<string>']})
};

fetch('https://api.example.com/api/community/link/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/community/link/:instance"

payload = {
    "communityJid": "<string>",
    "groupJid": ["<string>"]
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no

Description

Links one or more existing groups to a community. Each link has an internal 1s delay to avoid throttling from the WhatsApp server. Individual failures do not abort the operation, they go to the failed array.

Examples

Link 2 groups

Bulk-attaches 2 existing groups to the community 120363406289005073@g.us in a single call. The service applies an internal 1s delay between links to avoid throttling.

curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  }'

await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    communityJid: "120363406289005073@g.us",
    groupJid: [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "communityJid": "120363406289005073@g.us",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "communityJid": "120363406289005073@g.us",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/link/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Link 1 group

Links a single group to the community. The groupJid array accepts 1 or more items, useful when you want to add subgroups one by one.

curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": ["120363406289005074@g.us"]
  }'

await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    communityJid: "120363406289005073@g.us",
    groupJid: ["120363406289005074@g.us"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "communityJid": "120363406289005073@g.us",
        "groupJid":     ["120363406289005074@g.us"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "communityJid": "120363406289005073@g.us",
        "groupJid": ["120363406289005074@g.us"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/link/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Success response

Returns the count in message (format "Linked N of M groups to community"), the linked array with the JIDs successfully linked, and failed with the ones that were not processed (invalid JID, group already linked to another community, or bot lacking permission). success is true when at least one group was linked.

200 OK

{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}

Partial success and total failure both return HTTP 200. Always check success + failed[] on the client to detect per-group errors.

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

Community @g.us JID.

string[]

required

Array of @g.us JIDs of the groups to link. At least 1 item.

Notes

A group already linked to another community lands in failed[], unlink it first via /unlink.
Limit of 50 subgroups per community. Extras fail silently.
The Announcements group already belongs to the community since creation and cannot be linked.
The bot must be admin of both the community and the group being linked.

Errors

HTTP	Message
400	`community jid is required`
400	`group jid is required`
400	`Instance is not connected to WhatsApp`
500	`error parse community jid: <reason>`

Envelope:

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

Unlink groups

Remove groups from the community.

List subgroups

Confirm the linked subgroups.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Link 2 groups

Link 1 group

Success response

Path parameters

Headers

Request body

Notes

Errors

Next

Unlink groups

List subgroups

​Description

​Examples

​Link 2 groups

​Link 1 group

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

​Next

Unlink groups

List subgroups

Description

Examples

Link 2 groups

Link 1 group

Success response

Path parameters

Headers

Request body

Notes

Errors

Next