Delete
curl --request DELETE \
--url https://{appid}.api-{region}.cometchat.io/v3/users/{uid} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"permanent": "false"
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/users/{uid}"
payload = { "permanent": "false" }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({permanent: 'false'})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/users/{uid}', 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/users/{uid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'permanent' => 'false'
]),
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/users/{uid}"
payload := strings.NewReader("{\n \"permanent\": \"false\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permanent\": \"false\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permanent\": \"false\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "User with superhero6 has been deleted successfully."
}
}Users
Delete
Deletes a user for the specified UID
DELETE
/
users
/
{uid}
Delete
curl --request DELETE \
--url https://{appid}.api-{region}.cometchat.io/v3/users/{uid} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"permanent": "false"
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/users/{uid}"
payload = { "permanent": "false" }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({permanent: 'false'})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/users/{uid}', 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/users/{uid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'permanent' => 'false'
]),
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/users/{uid}"
payload := strings.NewReader("{\n \"permanent\": \"false\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permanent\": \"false\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permanent\": \"false\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "User with superhero6 has been deleted successfully."
}
}Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Path Parameters
An UID of a user.
Body
application/json
Permanently deletes the user along with all the messages, conversations, etc.
Response
200 - application/json
Deleted User
⌘I