POST
/
v1
/
subscribers
/
bulk
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
headerrequired

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

Body

application/json
subscribers
string[]
required

An array of subscribers to be created in bulk.

Was this page helpful?

Create subscriberGet subscriber