API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpsert 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
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.
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
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Body
An array of subscribers to be created in bulk.
Unique identifier of the subscriber
First name of the subscriber
Last name of the subscriber
Email address of the subscriber
Phone number of the subscriber
Avatar URL or identifier
Timezone of the subscriber
Locale of the subscriber
Additional custom data for the subscriber
Response
An array of subscribers that were successfully updated.
The ID of the subscriber that was updated.
An array of subscribers that were successfully created.
The ID of the subscriber that was created.
Was 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": []
}
}