Tooling

Node SDK

@rootmail/node — the whole API, fully typed, one import.

The official Node client wraps every endpoint with end-to-end TypeScript types, maps snake_case JSON to camelCase, normalizes errors into one RootMailError, and adds sub-tenant scoping.

terminal

pnpm add @rootmail/node

init.ts

import { RootMail } from "@rootmail/node";

const mail = new RootMail({
  apiKey: process.env.ROOTMAIL_API_KEY!,
  // baseUrl defaults to https://service.gateml.io
});

Resources

Each API area is a resource on the client:

`mail.messages`resource	create, get, list, audit, proof, recordEvent
`mail.templates`resource	create, get, list, update, remove
`mail.contacts`resource	create, get, unsubscribe
`mail.lists`resource	audiences + membership
`mail.campaigns`resource	create, send, analytics
`mail.sequences`resource	create, enroll, enrollments, analytics
`mail.threads`resource	list, get, reply
`mail.subTenants`resource	client domains + verify
`mail.webhooks`resource	endpoints + deliveries
`mail.deliverability / mail.analytics`resource	reputation + the funnel
`mail.suppressions / mail.imports`resource	do-not-send list + migration
`mail.compliance / mail.retention`resource	proof + retention
`mail.assistant`resource	the AI agent

Sub-tenant scoping

scoped.ts

const scoped = mail.withSubTenant("tnt_123");
await scoped.messages.create({ to, subject, html }); // sends as that client

tipSet idempotencyKey on any create call to make it safe to retry.

PreviousAI assistant Next CLI