Delete Chat Thread

DELETE

/v2/api/chat-thread/{chatthread_id}

Overview

Marks a specific chat thread as deleted using its unique identifier.

This endpoint is intended to logically delete a chat thread by setting its is_deleted flag to true.

Functionality

Required Parameter:

chatthread_id: Must be passed as a path parameter to identify the specific chat thread to be deleted.

Response Details:

Returns a list of deleted thread objects (typically one) for confirmation.

Each object includes full details such as id, title, created_by, timestamps, and associated user and agent.

How to View Chat thread ID

If you're unsure about the chat_thread_id, follow this guide:
How to View Chat thread ID

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Chat thread deleted successfully.

Body

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///v2/api/chat-thread/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Chat Thread Deleted Successfully.",
    "data": [
        {
            "id": 4076,
            "corpus_id": null,
            "created_by": "[email protected]",
            "created_on": "2025-01-08T22:00:19.910507Z",
            "modified_by": "",
            "modified_on": "2025-01-08T22:00:19.910532Z",
            "title": "Assistance Provided",
            "is_deleted": false,
            "chat_id": null,
            "agent": 1251,
            "user": 160
        }
    ]
}

Edit Chat Thread

Add ChatThread-Corpus Connection

Delete Chat Thread

Overview#

Functionality#

How to View Chat thread ID#

Request

Responses

Overview

Functionality

How to View Chat thread ID