Subscribers
Bulk create 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
- 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
Subscribers
Bulk create subscribers
Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. The bulk API is limited to 500 subscribers per request.
POST
/
v1
/
subscribers
/
bulk
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
object
*
subscribers
array
*
subscribers
Required
array
import { Novu } from "@novu/node";
const novu = new Novu("<NOVU_API_KEY>");
await novu.subscribers.bulkCreate([
{
subscriberId: "test-subscriber-1",
email: "test-user@sd.com",
firstName: "subscriber-1",
lastName: "test-1",
},
{
subscriberId: "test-subscriber-2",
email: "test-user-2@sd.com",
firstName: "subscriber-2",
lastName: "test-2",
},
{
subscriberId: "test-subscriber-3",
},
]);
{
"data": {
"updated": [],
"created": [
{
"subscriberId": "test-subscriber-1"
},
{
"subscriberId": "test-subscriber-2"
},
{
"subscriberId": "test-subscriber-3"
}
],
"failed": []
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
import { Novu } from "@novu/node";
const novu = new Novu("<NOVU_API_KEY>");
await novu.subscribers.bulkCreate([
{
subscriberId: "test-subscriber-1",
email: "test-user@sd.com",
firstName: "subscriber-1",
lastName: "test-1",
},
{
subscriberId: "test-subscriber-2",
email: "test-user-2@sd.com",
firstName: "subscriber-2",
lastName: "test-2",
},
{
subscriberId: "test-subscriber-3",
},
]);
{
"data": {
"updated": [],
"created": [
{
"subscriberId": "test-subscriber-1"
},
{
"subscriberId": "test-subscriber-2"
},
{
"subscriberId": "test-subscriber-3"
}
],
"failed": []
}
}
Authorizations
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Body
application/json
subscribers
string[]
requiredWas this page helpful?
import { Novu } from "@novu/node";
const novu = new Novu("<NOVU_API_KEY>");
await novu.subscribers.bulkCreate([
{
subscriberId: "test-subscriber-1",
email: "test-user@sd.com",
firstName: "subscriber-1",
lastName: "test-1",
},
{
subscriberId: "test-subscriber-2",
email: "test-user-2@sd.com",
firstName: "subscriber-2",
lastName: "test-2",
},
{
subscriberId: "test-subscriber-3",
},
]);
{
"data": {
"updated": [],
"created": [
{
"subscriberId": "test-subscriber-1"
},
{
"subscriberId": "test-subscriber-2"
},
{
"subscriberId": "test-subscriber-3"
}
],
"failed": []
}
}