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

​
Overview

Before using this feature, it’s important to verify whether the WhatsApp application on your mobile device already has community compatibility. If it’s available, you can use this API to create new communities.

​
Attributes

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

​
Required

​
name
string
required
Community name

​
Optional

​
description
string
Community description

​
Request Body

{
  "name": "My first Community"
}

​
Response

​
200

​
id
string
Created community ID
​
subGroups
array
Groups linked to the community
{
  "id": "98372465382764532938",
  "subGroups": [
    {
      "name": "My first Community",
      "phone": "342532456234453-group",
      "isGroupAnnouncement": 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”.