Node.js SDK

Official SDK with full TypeScript support

@resletter/node-sdk

The easiest way to integrate Resletter into your Node.js application.

View on npm

Installation

npm install @resletter/node-sdk
# or
yarn add @resletter/node-sdk
# or
pnpm add @resletter/node-sdk

Quick Start

import { Resletter } from '@resletter/node-sdk';

const client = new Resletter('rsl_your_api_key');

// Create a subscriber
const subscriber = await client.subscribers.create({
  email: '[email protected]',
  name: 'John Doe',
  metadata: { source: 'website' },
});

console.log('Created subscriber:', subscriber.id);

SDK Features

  • Full TypeScript support with type definitions
  • Subscribers: list, get, create, bulk create, update, delete
  • Groups: list, get, create, update, delete, add/remove subscribers
  • Campaigns: list, get, create, update, delete
  • Events: track custom events to trigger automations
  • Error handling with ResletterError class

Error Handling

import { Resletter, ResletterError } from '@resletter/node-sdk';

try {
  await client.subscribers.create({ email: 'invalid' });
} catch (error) {
  if (error instanceof ResletterError) {
    console.error('Status:', error.status);
    console.error('Message:', error.message);
    console.error('Code:', error.code);
  }
}

Requirements

  • Node.js 18.0.0 or higher
  • Resletter account with Starter plan or above (API access required)