Groups

Change Group Description

Changes the group description. An empty description is not allowed.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/group/updateDescription

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

Parameters

Name	Type	In	Required	Description
`groupjid`	text	body	Yes	Group ID (@g.us)
`description`	textarea	body	Yes	New description (max. 512 characters)

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/group/updateDescription" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"groupjid":"120363000000000000@g.us","description":"Descrição do grupo..."}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/group/updateDescription", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "groupjid": "120363000000000000@g.us",
    "description": "Descrição do grupo..."
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/group/updateDescription",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"groupjid":"120363000000000000@g.us","description":"Descrição do grupo..."},
)
print(res.json())

Response example

JSON

{
  "success": true
}

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

Other endpoints in this category

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.

Create free account View the documentation