Groups

Manage Community Groups

Adds or removes groups from an existing community. Use action: add or action: remove with the array of group JIDs.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/community/editgroups

Authentication with the x-api-key and x-api-secret headers.

Parameters

NameTypeInRequiredDescription
communitytextbodyYesCommunity JID
actionselectbodyYesAction
groupsjsonbodyYesGroup JIDs (JSON array)

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/community/editgroups" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"community":"120363000000000001@g.us","action":"add","groups":["120363000000000000@g.us"]}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/community/editgroups", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "community": "120363000000000001@g.us",
    "action": "add",
    "groups": [
      "120363000000000000@g.us"
    ]
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/community/editgroups",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"community":"120363000000000001@g.us","action":"add","groups":["120363000000000000@g.us"]},
)
print(res.json())

Response example

JSON

{
  "failed": null,
  "message": "community updated",
  "success": null
}

Values are illustrative; the fields follow the real response format.

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.