Delete A Conversation - CometChat Docs

Quick Reference for AI Agents & Developers

Delete conversation: CometChat.deleteConversation(conversationWith:conversationType:onSuccess:onError:)
Conversation types: .user, .group
Related: Retrieve Conversations · Messaging Overview

In case you want to delete a conversation, you can use the deleteConversation() method. This method takes two parameters. The unique id (UID/GUID) of the conversation to be deleted & the type (user/group) of conversation to be deleted.

Delete User Conversation

Swift

CometChat.deleteConversation(conversationWith: "cometchat-uid-1", conversationType: .user, onSuccess: { (message) in
    print("Conversation deleted: \(message)")
}, onError: { (error) in
    print("Error: \(error?.errorDescription)")
})

Sample Payloads - Delete User Conversation

Request
Success Response
Error Response

Method: CometChat.deleteConversation(conversationWith:conversationType:)

Parameter	Type	Value
conversationWith	`String`	`"cometchat-uid-1"`
conversationType	`CometChat.ConversationType`	`.user`

Response:

Parameter	Type	Value
message	`String`	`"Conversation deleted successfully."`

After Deletion:

Effect	Description
Conversation removed	For logged-in user only
Messages deleted	For logged-in user only
Other participants	Still have access

Object Type: CometChatException

Parameter	Type	Value
errorCode	`String`	`"ERR_CONVERSATION_NOT_FOUND"`
errorDescription	`String`	`"Conversation does not exist"`

Delete Group Conversation

Swift

CometChat.deleteConversation(conversationWith: "group-guid-1", conversationType: .group, onSuccess: { (message) in
    print("Conversation deleted: \(message)")
}, onError: { (error) in
    print("Error: \(error?.errorDescription)")
})

Sample Payloads - Delete Group Conversation

Request
Success Response
Error Response

Method: CometChat.deleteConversation(conversationWith:conversationType:)

Parameter	Type	Value
conversationWith	`String`	`"group-guid-1"`
conversationType	`CometChat.ConversationType`	`.group`

Response:

Parameter	Type	Value
message	`String`	`"Conversation deleted successfully."`

After Deletion:

Effect	Description
Conversation removed	For logged-in user only
Messages deleted	For logged-in user only
Other participants	Still have access

Object Type: CometChatException

Parameter	Type	Value
errorCode	`String`	`"ERR_GROUP_NOT_FOUND"`
errorDescription	`String`	`"Group does not exist"`

This method deletes the conversation only for the logged-in user. To delete a conversation for all the users of the conversation, please refer to our REST API documentation here.

Method Parameters

The deleteConversation() method takes the following parameters:

Parameter	Type	Required	Description
conversationWith	`String`	YES	UID of user or GUID of group
conversationType	`CometChat.ConversationType`	YES	`.user` or `.group`
onSuccess	`(String) -> Void`	YES	Success callback
onError	`(CometChatException?) -> Void`	YES	Error callback

Success & Failure Responses

Delete Conversation Success Response

When a conversation is successfully deleted, the onSuccess callback returns a success message:

Swift

CometChat.deleteConversation(conversationWith: "cometchat-uid-1", conversationType: .user, onSuccess: { (message) in
    // message: String - Success confirmation message
    print("Response: \(message)")  // "Conversation deleted successfully."
    
    // After deletion:
    // - Conversation removed from logged-in user's conversation list
    // - Messages are deleted for the logged-in user only
    // - Other participants still have access to the conversation
}, onError: { (error) in
    // Handle error
})

Delete Conversation Failure Response

When deletion fails, the onError callback returns a CometChatException:

Swift

CometChat.deleteConversation(conversationWith: "cometchat-uid-1", conversationType: .user, onSuccess: { (message) in
    // Success
}, onError: { (error) in
    print("Error Code: \(error?.errorCode ?? "")")
    print("Error Description: \(error?.errorDescription ?? "")")
    
    // Handle specific errors
    switch error?.errorCode {
    case "ERR_CONVERSATION_NOT_FOUND":
        // Conversation does not exist
        break
    case "ERR_UID_NOT_FOUND":
        // User with specified UID does not exist
        break
    case "ERR_GROUP_NOT_FOUND":
        // Group with specified GUID does not exist
        break
    case "ERR_NOT_LOGGED_IN":
        // User is not logged in
        break
    default:
        break
    }
})

After Deletion

Effect	Description
Conversation removed	For logged-in user only
Messages deleted	For logged-in user only
Other participants	Still have access

Common Error Codes

Error Code	Description	Resolution
`ERR_CONVERSATION_NOT_FOUND`	Conversation doesn’t exist	Verify conversation exists
`ERR_UID_NOT_FOUND`	User UID doesn’t exist	Verify user UID
`ERR_GROUP_NOT_FOUND`	Group GUID doesn’t exist	Verify group GUID
`ERR_NOT_LOGGED_IN`	User is not logged in	Login first

​Delete User Conversation

​Delete Group Conversation

​Method Parameters

​Success & Failure Responses

​Delete Conversation Success Response

​Delete Conversation Failure Response

​After Deletion

​Common Error Codes

Delete User Conversation

Delete Group Conversation

Method Parameters

Success & Failure Responses

Delete Conversation Success Response

Delete Conversation Failure Response

After Deletion

Common Error Codes