POST
/
groups
Create
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/groups \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "guid": "<string>",
  "name": "<string>",
  "type": "public",
  "password": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "metadata": {},
  "owner": "<string>",
  "tags": [
    "tag1"
  ],
  "members": {
    "admins": [],
    "moderators": [],
    "participants": [],
    "usersToBan": []
  }
}'
{
  "data": {
    "guid": "project-group",
    "name": "Project Group",
    "description": "project related discussions between members",
    "icon": "http://placehold.it/120x120&text=image1",
    "type": "public",
    "scope": "admin",
    "membersCount": 1,
    "joinedAt": 1638440784,
    "conversationId": "group_project-group",
    "hasJoined": true,
    "createdAt": 1638440784,
    "owner": "superhero4",
    "tags": [
      "friends",
      "project"
    ]
  }
}

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Headers

onBehalfOf
string

UID of the user on whose behalf the action is performed.

Body

application/json

Response

200 - application/json

Create Group

The response is of type object.