Skip to main content

dismissNotifications

Dismisses (soft-deletes) notifications for the current user, scoped to the company in context. Dismissed notifications will no longer appear in the notification feed.

This is an asynchronous operation that returns immediately with a process_id that can be used to track the operation status.

Authentication and Authorization​

Authentication is required. Users can only dismiss their own notifications.

Business Rules​

  • Either notificationIds or groupKeys (or both) must be provided
  • notificationIds dismisses specific individual notifications
  • groupKeys dismisses all notifications matching the given group keys
  • Already-dismissed notifications are not affected

Possible Errors​

  • **Validation error**: Neither notificationIds nor groupKeys was provided
  • **Authorization error**: Attempting to dismiss a notification that belongs to another user
dismissNotifications(
  input: DismissNotificationsInput!
): AsynchronousActionResponse!

Arguments​

dismissNotifications.input ● DismissNotificationsInput! non-null input common​

Parameters for DismissNotifications

Type​

AsynchronousActionResponse object common​

Asynchronous action response type