Bulk create subscribers

POST

subscribers

bulk

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.subscribers.createBulk({
    subscribers: [
      {
        subscriberId: "<id>",
      },
    ],
  });

  // Handle the result
  console.log(result);
}

run();

{
  "updated": [
    {
      "subscriberId": "<string>"
    }
  ],
  "created": [
    {
      "subscriberId": "<string>"
    }
  ],
  "failed": [
    {
      "message": "<string>",
      "subscriberId": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Body

application/json

subscribers

object[]

required

An array of subscribers to be created in bulk.

Response

201

application/json

Created

updated

object[]

required

An array of subscribers that were successfully updated.

created

object[]

required

An array of subscribers that were successfully created.

failed

object[]

required

An array of failed operations with error messages and optional subscriber IDs.

Was this page helpful?

Suggest edits Raise issue

Get subscribers Update subscriber credentials

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.subscribers.createBulk({
    subscribers: [
      {
        subscriberId: "<id>",
      },
    ],
  });

  // Handle the result
  console.log(result);
}

run();

{
  "updated": [
    {
      "subscriberId": "<string>"
    }
  ],
  "created": [
    {
      "subscriberId": "<string>"
    }
  ],
  "failed": [
    {
      "message": "<string>",
      "subscriberId": "<string>"
    }
  ]
}

API Reference

Events

Notifications

Integrations

Subscribers

Messages

Topics

Bulk create subscribers

Authorizations

Headers

Body

Response