Subscriber Preference
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Subscriber Preference
By default, Novu will show the subscriber preferences cog icon on the notification center component. If you want to hide it, you can use the prop showUserPreferences
 on the PopoverNotificationCenter
 component.
Users can enable/disable any active channel in the workflow using subscriber preferences
Get subscriber preferences
import { Novu } from "@novu/node";
const novu = new Novu("<NOVU_API_KEY>");
// 111 is subscriberId
await novu.subscribers.getPreference("111");
Update subscriber preference for a workflow
import { Novu, ChannelTypeEnum } from "@novu/node";
const novu = new Novu("<NOVU_API_KEY>");
// enable in_app channel
await novu.subscribers.updatePreference("subscriberId", "workflowIdentifier", {
enabled: true,
channel: { type: ChannelTypeEnum.IN_APP, enabled: true },
});
// enable email channel
await novu.subscribers.updatePreference("subscriberId", "workflowIdentifier", {
enabled: true,
channel: { type: ChannelTypeEnum.EMAIL, enabled: true },
});
Read more about subscriber preference.
Was this page helpful?