Skip to main content

clearAllNotifications()

clearAllNotifications(options?: ClearAllOptions): Promise<SimpleResponse>

Defined in: packages/core/src/index.ts:1533

Clear all notifications (inbox, archived, or both)

Parameters

ParameterTypeDescription
options?ClearAllOptionsOptions specifying which notifications to clear (inbox, archived, or all)

Returns

Promise<SimpleResponse>

Confirmation of clear operation

Throws

401 - Not authenticated

Example

import { clearAllNotifications } from "@cpod/sdk";

// Clear inbox only
await clearAllNotifications({ type: "inbox" });

// Clear archived only
await clearAllNotifications({ type: "archived" });

// Clear all notifications
await clearAllNotifications({ type: "all" });