- API Reference
- Discord Support
- 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 preference
- 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
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Update subscriber preference
The subscriber preferences for every ChannelTypeEnum for the workflow assigned.
The type of channel that is enabled or not
If channel is enabled or not
Sets if the workflow is fully enabled for all channels or not for the subscriber.
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
Path Parameters
Body
The subscriber preferences for every ChannelTypeEnum for the workflow assigned.
The type of channel that is enabled or not
in_app
, email
, sms
, chat
, push
If channel is enabled or not
Sets if the workflow is fully enabled for all channels or not for the subscriber.
Response
The workflow information and if it is critical or not
Unique identifier of the workflow
Name of the workflow
Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen
Triggers are the events that will trigger the workflow.
The preferences of the subscriber regarding the related workflow
Sets if the workflow is fully enabled for all channels or not for the subscriber.
Subscriber preferences for the different channels regarding this workflow
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"
}
}
}