Update subscriber global preferences
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 global preferences
PATCH
/
v1
/
subscribers
/
{subscriberId}
/
preferences
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.subscribers.preferences.updateGlobal("<value>", {});
// Handle the result
console.log(result)
}
run();{
"template": {
"_id": "<string>",
"name": "<string>",
"critical": true,
"triggers": [
"<string>"
]
},
"preference": {
"enabled": true,
"channels": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}
}Enter your API key in the Authorization field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Body
application/json
Enable or disable the subscriber global preferences.
Response
200
application/json
Ok
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.
Was this page helpful?
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.subscribers.preferences.updateGlobal("<value>", {});
// Handle the result
console.log(result)
}
run();{
"template": {
"_id": "<string>",
"name": "<string>",
"critical": true,
"triggers": [
"<string>"
]
},
"preference": {
"enabled": true,
"channels": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}
}