Delete Conversation

This API is deprecated please use Reset User/GroupConversation API

DELETE /conversations/{conversationId}

Delete Conversation

cURL

curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/conversations/{conversationId} \
  --header 'apikey: <api-key>' \
  --header 'onBehalfOf: <onbehalfof>'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/conversations/{conversationId}"

headers = {
    "onBehalfOf": "<onbehalfof>",
    "apikey": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {onBehalfOf: '<onbehalfof>', apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/conversations/{conversationId}', 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/conversations/{conversationId}",
  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>",
    "onBehalfOf: <onbehalfof>"
  ],
]);

$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/conversations/{conversationId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("onBehalfOf", "<onbehalfof>")
	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/conversations/{conversationId}")
  .header("onBehalfOf", "<onbehalfof>")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/conversations/{conversationId}")

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

request = Net::HTTP::Delete.new(url)
request["onBehalfOf"] = '<onbehalfof>'
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "success": true,
    "message": "The conversation group_project-group has been deleted successfully for all the users."
  }
}

This endpoint is deprecated and will be removed in a future API version.

Use the type-specific endpoints instead:

Old Endpoint	New Endpoint
DELETE /conversations/{conversationId}	DELETE /users/{uid}/conversation or DELETE /groups/{guid}/conversation

Migration example:

# Old (deprecated):
curl -X DELETE "https://appid.api-us.cometchat.io/v3/conversations/user_cometchat-uid-1_user_cometchat-uid-2" \
  -H "apikey: YOUR_API_KEY"

# New (recommended) — for a user conversation:
curl -X DELETE "https://appid.api-us.cometchat.io/v3/users/cometchat-uid-2/conversation" \
  -H "apikey: YOUR_API_KEY" \
  -H "onBehalfOf: cometchat-uid-1"

Authorizations

apikey · string · header · required

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

Headers

onBehalfOf · string · required

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

Path Parameters

conversationId · string · required

(Required) conversation id

Response

200 - application/json

Deleted Conversations

data · object