Unset Scope Permissions
curl --request DELETE \
--url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission} \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}"
headers = {"apikey": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {apikey: '<api-key>'}};
fetch('https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}', 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}/scopes/{scope}/permissions/{permission}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"permissions": {
"sendMessage": "allow",
"listMembers": "allow",
"listMembers.allowedScopes": "participant",
"addReaction": "deny",
"listReactions.allowedScopes": "moderator",
"listReactions": "deny",
"sendThreadedMessage": "allow",
"initiateCall": "deny",
"initiateCall.allowedScopes": "participant",
"initiateCall.allowedType": "audio",
"editMessage": "allow"
}
}
}Role Based Access Control
Unset Scope Permissions
Removes a specific permission from a group scope
DELETE
/
groups
/
{guid}
/
scopes
/
{scope}
/
permissions
/
{permission}
Unset Scope Permissions
curl --request DELETE \
--url https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission} \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}"
headers = {"apikey": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {apikey: '<api-key>'}};
fetch('https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}', 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}/scopes/{scope}/permissions/{permission}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/groups/{guid}/scopes/{scope}/permissions/{permission}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"permissions": {
"sendMessage": "allow",
"listMembers": "allow",
"listMembers.allowedScopes": "participant",
"addReaction": "deny",
"listReactions.allowedScopes": "moderator",
"listReactions": "deny",
"sendThreadedMessage": "allow",
"initiateCall": "deny",
"initiateCall.allowedScopes": "participant",
"initiateCall.allowedType": "audio",
"editMessage": "allow"
}
}
}For the complete error reference, see Error Guide.
Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Path Parameters
The group GUID to remove scope permission from
Example:
"supergroup"
The scope identifier (e.g., admin, moderator, participant)
Example:
"admin"
The permission key to unset (e.g., sendMessage, initiateCall, etc.)
Example:
"sendMessage"
Response
200 - application/json
Scope permission unset successfully
Was this page helpful?