NodeJS

Prerequisites

Ozi API key
Verified domain

Using SDK

Install SDK

npm install ozi-js

yarn add ozi-js

pnpm add ozi-js

bun add ozi-js

Initialize SDK

Get the API key from the Ozi dashboard and initialize the SDK. Pass it to the constructor, or set OZI_API_KEY and leave it out:

import { Ozi } from "ozi-js";

const ozi = new Ozi("us_12345");

Send Email

ozi.emails.send({
  to: "[email protected]",
  from: "[email protected]",
  subject: "Hello from Ozi",
  html: "<p>Sent with Ozi</p>",
  text: "Sent with Ozi",
  headers: {
    "X-Campaign": "welcome",
  },
});

Custom headers are forwarded as-is. Ozi only manages the X-Ozi-Email-ID and References headers.

Adding contacts programatically

Get the contact book id

Get the contact book id from the Ozi dashboard. Copy the contact book id

Add contacts

ozi.contacts
  .create("clzeydgeygff", {
    email: "[email protected]",
    firstName: "Koushik",
    lastName: "KM",
  })

Update contact

ozi.contacts.update("clzeydgeygff", contactId, {
  firstName: "Koushik",
  lastName: "KM",
});

Getting Started

Guides

Prerequisites

Using SDK

Adding contacts programatically

​Prerequisites

​Using SDK

​Adding contacts programatically

Prerequisites

Using SDK

Adding contacts programatically