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.

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_SECRET_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": []
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

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

subscribers.channels

object[]

Show child attributes

subscribers.channels.providerId

object

required

subscribers.channels.credentials

object

required

Show child attributes

subscribers.channels.credentials.webhookUrl

string

subscribers.channels.credentials.deviceTokens

string[]

subscribers.channels.integrationIdentifier

string