Skip to main content
POST
/
groups
/
{guid}
/
members
Add members
curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "admins": [],
  "moderators": [],
  "participants": [],
  "usersToBan": []
}
'
import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members"

payload = {
    "admins": [],
    "moderators": [],
    "participants": [],
    "usersToBan": []
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({admins: [], moderators: [], participants: [], usersToBan: []})
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'admins' => [
        
    ],
    'moderators' => [
        
    ],
    'participants' => [
        
    ],
    'usersToBan' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members"

	payload := strings.NewReader("{\n  \"admins\": [],\n  \"moderators\": [],\n  \"participants\": [],\n  \"usersToBan\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"admins\": [],\n  \"moderators\": [],\n  \"participants\": [],\n  \"usersToBan\": []\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"admins\": [],\n  \"moderators\": [],\n  \"participants\": [],\n  \"usersToBan\": []\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "usersToBan": {
      "cometchat-uid-6": {
        "success": true
      }
    },
    "admins": {
      "cometchat-uid-1": {
        "success": true,
        "data": {
          "id": "32",
          "conversationId": "group_project-group",
          "sender": "app_system",
          "receiverType": "group",
          "receiver": "project-group",
          "category": "action",
          "type": "groupMember",
          "data": {
            "action": "added",
            "entities": {
              "by": {
                "entity": {
                  "uid": "app_system",
                  "name": "System",
                  "role": "default",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "on": {
                "entity": {
                  "uid": "cometchat-uid-1",
                  "name": "Andrew Joseph",
                  "role": "default",
                  "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "for": {
                "entity": {
                  "guid": "project-group",
                  "icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
                  "name": "Project Group",
                  "tags": [
                    "friends",
                    "project"
                  ],
                  "type": "public",
                  "owner": "cometchat-uid-2",
                  "createdAt": 1625460947,
                  "description": "project related discussions between members",
                  "membersCount": 2,
                  "conversationId": "group_project-group"
                },
                "entityType": "group"
              }
            }
          },
          "sentAt": 1625460972,
          "updatedAt": 1625460972
        }
      }
    },
    "moderators": {
      "cometchat-uid-3": {
        "success": true,
        "data": {
          "id": "33",
          "conversationId": "group_project-group",
          "sender": "app_system",
          "receiverType": "group",
          "receiver": "project-group",
          "category": "action",
          "type": "groupMember",
          "data": {
            "action": "added",
            "entities": {
              "by": {
                "entity": {
                  "uid": "app_system",
                  "name": "System",
                  "role": "default",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "on": {
                "entity": {
                  "uid": "cometchat-uid-3",
                  "name": "Nancy Grace",
                  "role": "default",
                  "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-3.webp",
                  "status": "offline",
                  "createdAt": 1596537299,
                  "updatedAt": 1625234590
                },
                "entityType": "user"
              },
              "for": {
                "entity": {
                  "guid": "project-group",
                  "icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
                  "name": "Project Group",
                  "tags": [
                    "friends",
                    "project"
                  ],
                  "type": "public",
                  "owner": "cometchat-uid-2",
                  "createdAt": 1625460947,
                  "updatedAt": 1625460972,
                  "description": "project related discussions between members",
                  "membersCount": 3,
                  "conversationId": "group_project-group"
                },
                "entityType": "group"
              }
            }
          },
          "sentAt": 1625460973,
          "updatedAt": 1625460973
        }
      }
    },
    "participants": {
      "cometchat-uid-4": {
        "success": true,
        "data": {
          "id": "34",
          "conversationId": "group_project-group",
          "sender": "app_system",
          "receiverType": "group",
          "receiver": "project-group",
          "category": "action",
          "type": "groupMember",
          "data": {
            "action": "added",
            "entities": {
              "by": {
                "entity": {
                  "uid": "app_system",
                  "name": "System",
                  "role": "default",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "on": {
                "entity": {
                  "uid": "cometchat-uid-4",
                  "name": "Susan Marie",
                  "role": "default",
                  "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-4.webp",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "for": {
                "entity": {
                  "guid": "project-group",
                  "icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
                  "name": "Project Group",
                  "tags": [
                    "friends",
                    "project"
                  ],
                  "type": "public",
                  "owner": "cometchat-uid-2",
                  "createdAt": 1625460947,
                  "updatedAt": 1625460973,
                  "description": "project related discussions between members",
                  "membersCount": 4,
                  "conversationId": "group_project-group"
                },
                "entityType": "group"
              }
            }
          },
          "sentAt": 1625460973,
          "updatedAt": 1625460973
        }
      },
      "cometchat-uid-5": {
        "success": true,
        "data": {
          "id": "35",
          "conversationId": "group_project-group",
          "sender": "app_system",
          "receiverType": "group",
          "receiver": "project-group",
          "category": "action",
          "type": "groupMember",
          "data": {
            "action": "added",
            "entities": {
              "by": {
                "entity": {
                  "uid": "app_system",
                  "name": "System",
                  "role": "default",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "on": {
                "entity": {
                  "uid": "cometchat-uid-5",
                  "name": "John Paul",
                  "role": "default",
                  "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-5.webp",
                  "status": "offline",
                  "createdAt": 1596537299
                },
                "entityType": "user"
              },
              "for": {
                "entity": {
                  "guid": "project-group",
                  "icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
                  "name": "Project Group",
                  "tags": [
                    "friends",
                    "project"
                  ],
                  "type": "public",
                  "owner": "cometchat-uid-2",
                  "createdAt": 1625460947,
                  "updatedAt": 1625460973,
                  "description": "project related discussions between members",
                  "membersCount": 5,
                  "conversationId": "group_project-group"
                },
                "entityType": "group"
              }
            }
          },
          "sentAt": 1625460973,
          "updatedAt": 1625460973
        }
      }
    }
  }
}
For the complete error reference, see Error Guide.

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.

Path Parameters

​
guid
string
required

A GUID of a group.

Body

application/json
​
admins
string[]

UIDs of users to be made admins.

​
moderators
string[]

UIDs of users to be made moderators.

​
participants
string[]

UIDs of users to be made participants.

​
usersToBan
string[]

UIDs of the users to be banned from the group.

Response

200 - application/json

Create Group Members

​
data
object