Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Headers
A header for idempotency purposes
API Reference
Notifications
Integrations
Subscribers
- GETGet subscribers
- POSTBulk create subscribers
- PUTUpdate subscriber credentials
- PATCHModify subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber messages as seen, read, unseen or unread
- 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
- GETSearch for subscribers
- POSTCreate subscriber
- GETGet subscriber
- DELDelete subscriber
- PATCHPatch subscriber
- GETGet subscriber preferences
- PATCHUpdate subscriber global or workflow specific preferences
TypeScript
Copy
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.subscribers.delete("<id>");
// Handle the result
console.log(result);
}
run();Copy
{
"acknowledged": true,
"status": "success"
}Subscribers
Delete subscriber
Deletes a subscriber entity from the Novu platform
DELETE
/
v2
/
subscribers
/
{subscriberId}
TypeScript
Copy
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.subscribers.delete("<id>");
// Handle the result
console.log(result);
}
run();Copy
{
"acknowledged": true,
"status": "success"
}Was this page helpful?
⌘I