Bulk create subscribers

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Node.js

import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.subscribers.bulkCreate([
    {
        subscriberId: 'test-subscriber-1',
        email: '[e-mail]',
        firstName: 'subscriber-1',
        lastName: 'test-1',
    },
    {
        subscriberId: 'test-subscriber-2',
        email: '[e-mail]',
        firstName: 'subscriber-2',
        lastName: 'test-2',
    },
    {
        subscriberId: 'test-subscriber-3',
    },
]);

Response

{
    "data": {
        "updated": [],
        "created": [
        {
            "subscriberId": "test-subscriber-1"
        },
        {
            "subscriberId": "test-subscriber-2"
        },
        {
            "subscriberId": "test-subscriber-3"
        }
        ],
        "failed": []
    }
}

Body

application/json

subscribers · object[] · required

Show child attributes

subscribers. subscriberId · string · required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

subscribers. email · string

subscribers. firstName · string

subscribers. lastName · string

subscribers. phone · string

subscribers. avatar · string

An http url to the profile image of your subscriber

subscribers. locale · string

subscribers. data · object