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

​
Overview

With this API you can remove groups from a community. You will need the community ID and the phone numbers of the groups you want to remove.
A community must maintain at least 1 linked group (excluding the announcement group), so you cannot remove a group if it’s the only common group linked.

​
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
​
groupsPhones
array
required
Array with the phone numbers of groups to be unlinked

​
Request Body

{
  "communityId": "98372465382764532938",
  "groupsPhones": ["1345353454354354-group"]
}

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