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

Overview

With this API you 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
whoCanAddNewGroups
string
required
Who can add new groups: admins or all

Request Body

{
  "communityId": "98372465382764532938",
  "whoCanAddNewGroups": "admins"
}

Response

200

{
  "success": 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”.