Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-community-description
Update community description
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-community-description \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "communityId": "<string>",
  "communityDescription": "<string>"
}
'

​
Overview

This method allows you to update the community description.
Only administrators can change community settings.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
communityId
string
required
Community ID
​
communityDescription
string
required
New community description

​
Request Body

{
  "communityId": "120363019502650977",
  "communityDescription": "community description"
}

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.