NotificationsService.md

NotificationsService

A list of all methods in the NotificationsService service. Click on the method name to view detailed information about that method.

Methods	Description
listNotifications	Lists all notifications for a user.
archiveNotification	Archives a notification.
markNotificationRead	Marks a notification as read.
unarchiveNotification	Unarchives a notification.
markNotificationUnread	Marks a notification as unread.

listNotifications

Lists all notifications for a user.

• HTTP Method: GET
• Endpoint: /notifications

Parameters

Name	Type	Required	Description
requestParameters	ListNotificationsParameters	❌	Request Parameters Object

Return Type

NotificationCollection

Example Usage Code Snippet

import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;
import com.magicbell.magicbelluserclient.models.ListNotificationsParameters;
import com.magicbell.magicbelluserclient.models.NotificationCollection;

public class Main {

  public static void main(String[] args) {
    MagicbellUserClientConfig config = MagicbellUserClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

    ListNotificationsParameters requestParameters = ListNotificationsParameters.builder()
      .limit(7L)
      .startingAfter("starting_after")
      .endingBefore("ending_before")
      .status("status")
      .topic("topic")
      .build();

    NotificationCollection response = magicbellUserClient.notifications.listNotifications(requestParameters);

    System.out.println(response);
  }
}

archiveNotification

Archives a notification.

• HTTP Method: POST
• Endpoint: /notifications/{notification_id}/archive

Parameters

Name	Type	Required	Description
notificationId	String	✅

Example Usage Code Snippet

import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;

public class Main {

  public static void main(String[] args) {
    MagicbellUserClientConfig config = MagicbellUserClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

    magicbellUserClient.notifications.archiveNotification("notification_id");
  }
}

markNotificationRead

Marks a notification as read.

• HTTP Method: POST
• Endpoint: /notifications/{notification_id}/read

Parameters

Name	Type	Required	Description
notificationId	String	✅

Example Usage Code Snippet

import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;

public class Main {

  public static void main(String[] args) {
    MagicbellUserClientConfig config = MagicbellUserClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

    magicbellUserClient.notifications.markNotificationRead("notification_id");
  }
}

unarchiveNotification

Unarchives a notification.

• HTTP Method: POST
• Endpoint: /notifications/{notification_id}/unarchive

Parameters

Name	Type	Required	Description
notificationId	String	✅

Example Usage Code Snippet

import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;

public class Main {

  public static void main(String[] args) {
    MagicbellUserClientConfig config = MagicbellUserClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

    magicbellUserClient.notifications.unarchiveNotification("notification_id");
  }
}

markNotificationUnread

Marks a notification as unread.

• HTTP Method: POST
• Endpoint: /notifications/{notification_id}/unread

Parameters

Name	Type	Required	Description
notificationId	String	✅

Example Usage Code Snippet

import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;

public class Main {

  public static void main(String[] args) {
    MagicbellUserClientConfig config = MagicbellUserClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

    magicbellUserClient.notifications.markNotificationUnread("notification_id");
  }
}