novu-manage-subscribers

Files (4)

• SKILL.md
• credentials-examples.md · references/
• subscriber-crud-examples.md · references/
• topics-examples.md · references/

SKILL.md (first lines)

# Manage Subscribers

Subscribers are the recipients of your notifications. Each subscriber has a unique `subscriberId` — typically your application's user ID.

## SDK Setup

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

const novu = new Novu({
  secretKey: process.env.NOVU_SECRET_KEY,
});
```

## Create a Subscriber

```typescript
await novu.subscribers.create({
  subscriberId: "user-123",       // required — your system's user ID
  email: "jane@example.com",      // optional
  firstName: "Jane",              // optional
  lastName: "Doe",                // optional
  phone: "+15551234567",          // optional
  avatar: "https://example.com/jane.jpg",  // optional
  locale: "en-US",                // optional
  timezone: "America/New_York",   // optional
  data: {                         // optional — custom key-value data
    plan: "pro",
    company: "Acme Inc",
  },
});
```

**Only `subscriberId` is required.** All other fields are optional.

## Retrieve a Subscriber

```typescript
const subscriber = await novu.subscribers.retrieve("user-123");
```

## Search Subscribers

```typescript
const results = await novu.subscribers.search({
  email: "jane@example.com",
});
```

## Update a Subscriber

```typescript
await novu.subscribers.patch(
  { firstName: "Jane", data: { plan: "enterprise" } },
  // subscriberId
  "user-123"
);
```

## Delete a Subscriber

```typescript
await novu.subscribers.delete("user-123");
```

## Bulk Create

Create multiple subscribers at once. 500 subscribers can be created in one request.

```typescript
await novu.subscribers.createBulk({
  subscribers: [
    { subscriberId: "user-1", email: "alice@example.com", firstName: "Alice" },
    { subscriberId: "user-2", email: "bob@example.com", firstName: "Bob" },
    { subscriberId: "user-3", email: "carol@example.com", firstName: "Carol" },
  ],
});
```

## Topics

Topics are named groups of subscribers. Use them to send notifications to multiple subscribers at once.

### Create a Topic

```typescript
await novu.topics.create({
  key: "engineering-team",
  name: "Engineering Team",
});
```

### Add Subscribers to a Topic

```typescript
await novu.topics.subscriptions.create(
  { subscriptions: ["subscriberId-1", "subscriberId-2", "subscriberId-3"] },
  "engineering-team-topic"
);
```

### Remove Subscribers from a Topic

```typescript
await novu.topics.subscriptions.delete(
  { subscriptions: ["subscriberId-1", "subscriberId-2"] },
  "engineering-team-topic"
);
```

### List Topics

```typescript
const topics = await novu.topics.list({

});
```

### Delete a Topic

From novuhq/skills, MIT.

More from novuhq/skills