Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk-js): note that chat clear and delete purge stored history

Yudhi Armyndharis55d043f0785f
diff --git a/sdk/javascript/src/resources/chats.ts b/sdk/javascript/src/resources/chats.ts
index 00eaab8d8..3cba796cd 100644
--- a/sdk/javascript/src/resources/chats.ts
+++ b/sdk/javascript/src/resources/chats.ts
@@ -127,7 +127,9 @@ export class ChatsResource {
/**
* Delete every message in a chat, keeping the chat itself. `success: false` means the engine
- * declined — an unknown chat, or on Baileys a chat with no known history.
+ * declined — an unknown chat, or on Baileys a chat with no known history. On success the gateway
+ * also deletes its stored copy of the chat's messages (rows, inline and archived media, search
+ * entries); export the history first if you need it.
*/
clearMessages(sessionId: string, chatId: string): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
@@ -136,7 +138,11 @@ export class ChatsResource {
});
}
- /** Delete a chat from the chat list. */
+ /**
+ * Delete a chat from the chat list. On success the gateway also deletes its stored copy of the
+ * chat's messages (rows, inline and archived media, search entries); export the history first if
+ * you need it.
+ */
delete(sessionId: string, body: DeleteChatRequest): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',