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
Update subscriber preference
import co.novu.common.base.Novu;
import co.novu.api.subscribers.requests.UpdateSubscriberPreferenceRequest;
import co.novu.api.subscribers.responses.SingleSubscriberPrefResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
String templateId = "<TEMPLATE_ID>";
PreferenceChannel channel = new PreferenceChannel();
channel.setType("<TYPE>");
channel.setEnabled(true);
UpdateSubscriberPreferenceRequest request = new UpdateSubscriberPreferenceRequest();
request.setEnabled(false);
request.setChannel(channel);
SingleSubscriberPrefResponse response = novu.updateSubscriberPreferences(request, subscriberId, templateId);
}
}
{
"data": {
"preference": {
"channels": {
"chat": "boolean",
"email": "boolean",
"in_app": "boolean",
"push": "boolean",
"sms": "boolean"
},
"enabled": "boolean"
},
"template": {
"_id": "string",
"critical": "boolean",
"name": "string"
}
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
import co.novu.common.base.Novu;
import co.novu.api.subscribers.requests.UpdateSubscriberPreferenceRequest;
import co.novu.api.subscribers.responses.SingleSubscriberPrefResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
String templateId = "<TEMPLATE_ID>";
PreferenceChannel channel = new PreferenceChannel();
channel.setType("<TYPE>");
channel.setEnabled(true);
UpdateSubscriberPreferenceRequest request = new UpdateSubscriberPreferenceRequest();
request.setEnabled(false);
request.setChannel(channel);
SingleSubscriberPrefResponse response = novu.updateSubscriberPreferences(request, subscriberId, templateId);
}
}
{
"data": {
"preference": {
"channels": {
"chat": "boolean",
"email": "boolean",
"in_app": "boolean",
"push": "boolean",
"sms": "boolean"
},
"enabled": "boolean"
},
"template": {
"_id": "string",
"critical": "boolean",
"name": "string"
}
}
}
Was this page helpful?
import co.novu.common.base.Novu;
import co.novu.api.subscribers.requests.UpdateSubscriberPreferenceRequest;
import co.novu.api.subscribers.responses.SingleSubscriberPrefResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
String templateId = "<TEMPLATE_ID>";
PreferenceChannel channel = new PreferenceChannel();
channel.setType("<TYPE>");
channel.setEnabled(true);
UpdateSubscriberPreferenceRequest request = new UpdateSubscriberPreferenceRequest();
request.setEnabled(false);
request.setChannel(channel);
SingleSubscriberPrefResponse response = novu.updateSubscriberPreferences(request, subscriberId, templateId);
}
}
{
"data": {
"preference": {
"channels": {
"chat": "boolean",
"email": "boolean",
"in_app": "boolean",
"push": "boolean",
"sms": "boolean"
},
"enabled": "boolean"
},
"template": {
"_id": "string",
"critical": "boolean",
"name": "string"
}
}
}