Subscribers
Bulk create subscribers
- API Overview
- API Rate Limiting
Events
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 preferences by level
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notifications feed of subscriber.
- GETGet unseen in-app notifications count
- POSTMarks a message as read/unread, seen/unseen.
- POSTMarks all messages as read/unread, seen/unseen.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GET
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Environments
Changes
Execution Details
Feeds
Tenants
Organizations
Messages
API Reference
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_SECRET_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_SECRET_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_SECRET_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": []
}
}