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

​
Overview

With this API you can add other groups to a community.
It’s not possible to link the same group to more than one community. If you submit 3 groups and 1 already belongs to another community, 2 will be added while the other returns an error indicating it’s already part of another community.

​
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 IDs/Phones of the groups to be linked

​
Request Body

{
  "communityId": "98372465382764532938",
  "groupsPhones": ["1345353454354354-group", "1203634230225498-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”.