Update
curl --request PUT \
--url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"name": "<string>",
"password": "<string>",
"icon": "<string>",
"description": "<string>",
"metadata": {},
"owner": "<string>",
"tags": [
"tag1"
],
"unset": []
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}"
payload = {
"name": "<string>",
"password": "<string>",
"icon": "<string>",
"description": "<string>",
"metadata": {},
"owner": "<string>",
"tags": ["tag1"],
"unset": []
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
password: '<string>',
icon: '<string>',
description: '<string>',
metadata: {},
owner: '<string>',
tags: ['tag1'],
unset: []
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'password' => '<string>',
'icon' => '<string>',
'description' => '<string>',
'metadata' => [
],
'owner' => '<string>',
'tags' => [
'tag1'
],
'unset' => [
]
]),
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}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"guid": "project-group",
"name": "Project Group",
"description": "project related discussions between members",
"icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
"type": "public",
"scope": "admin",
"membersCount": 1,
"joinedAt": 1638440784,
"conversationId": "group_project-group",
"hasJoined": true,
"createdAt": 1638440784,
"owner": "cometchat-uid-4",
"tags": [
"friends",
"project"
]
}
}Groups
Update
Updates the group details for a given GUID.
PUT
/
groups
/
{guid}
Update
curl --request PUT \
--url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"name": "<string>",
"password": "<string>",
"icon": "<string>",
"description": "<string>",
"metadata": {},
"owner": "<string>",
"tags": [
"tag1"
],
"unset": []
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}"
payload = {
"name": "<string>",
"password": "<string>",
"icon": "<string>",
"description": "<string>",
"metadata": {},
"owner": "<string>",
"tags": ["tag1"],
"unset": []
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
password: '<string>',
icon: '<string>',
description: '<string>',
metadata: {},
owner: '<string>',
tags: ['tag1'],
unset: []
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'password' => '<string>',
'icon' => '<string>',
'description' => '<string>',
'metadata' => [
],
'owner' => '<string>',
'tags' => [
'tag1'
],
'unset' => [
]
]),
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}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"icon\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"owner\": \"<string>\",\n \"tags\": [\n \"tag1\"\n ],\n \"unset\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"guid": "project-group",
"name": "Project Group",
"description": "project related discussions between members",
"icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
"type": "public",
"scope": "admin",
"membersCount": 1,
"joinedAt": 1638440784,
"conversationId": "group_project-group",
"hasJoined": true,
"createdAt": 1638440784,
"owner": "cometchat-uid-4",
"tags": [
"friends",
"project"
]
}
}For the complete error reference, see Error Guide.
Authorizations
Body
application/json
Was this page helpful?