Skip to main content

removeThread

plugin.chatApi.removeThread(data: ThreadIdRequest): Promise<void>

Removes a thread.

Removes the specified thread from the chat system. This is a soft-delete that marks the thread as removed.

Parameters

ParameterTypeRequiredDescription
dataThreadIdRequestYesThe thread identifier

Returns

Promise<void> — A promise that resolves when the thread has been removed

Example

import plugin from '@codebolt/plugin-sdk';

const result = await plugin.chatApi.removeThread(/* ThreadIdRequest */);
console.log(result);