Skip to content


The method is aimed for creating a group chat.


To create a group chat, you have to execute a request at:


For idInstance and apiTokenInstance request parameters, refer to Before you start section.

Request parameters#

Parameter Type Mandatory Description
groupName string Yes New group chat name
chatIds array Yes Collection of group participants Ids

Request body example#

    "groupName": "Group created by Green API",
    "chatIds": [


Response parameters#

Parameter Type Description
created boolean Group creation flag
chatId string Group chat Id
groupInviteLink string Group invitation link

Response body example#

    "created": true,
    "chatId": "",
    "groupInviteLink": ""

CreateGroup errors#

For a list of errors common to all methods, refer to Common errors section

Python request example#

import requests

url = "{{idInstance}}/createGroup/{{apiTokenInstance}}"

payload = "{\r\n\t\"groupName\": \"Group created by Green API\",\r\n    \"chatIds\": [\r\n        \"\",\r\n        \"\"\r\n    ]\r\n}\r\n"
headers = {
  'Content-Type': 'application/json'

response = requests.request("POST", url, headers=headers, data = payload)