Skip to main content
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
communities
/
{communityId}
Deactivate community
curl --request DELETE \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities/{communityId} \
  --header 'Client-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This method is responsible for deactivating a community.
Deactivating the community will not delete your groups, but will remove them from the community.

​
Attributes

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

​
Path

​
communityId
string
required
Community ID

​
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”.