DELETE
/
conversations
/
{conversationId}
Delete Conversation
curl --request DELETE \
  --url https://{appid}.api-{region}.cometchat.io/v3/conversations/{conversationId} \
  --header 'apikey: <api-key>' \
  --header 'onBehalfOf: <onbehalfof>'
{
  "data": {
    "success": true,
    "message": "The conversation group_project-group has been deleted successfully for all the users."
  }
}

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

The response is of type object.