# Elastic Email TypeScript SDK
The official TypeScript / JavaScript client library for the [Elastic Email](https://elasticemail.com) REST API v4, built on [axios](https://axios-http.com).
[](https://www.npmjs.com/package/@elasticemail/elasticemail-client-ts-axios)
[](https://www.npmjs.com/package/@elasticemail/elasticemail-client-ts-axios)
[](https://www.typescriptlang.org)
[](https://elasticemail.com/developers/api-documentation/rest-api)
[](https://openapi-generator.tech)
[](LICENSE)
[](https://github.com/ElasticEmail/elasticemail-ts-axios/releases)
[](https://github.com/ElasticEmail/elasticemail-ts-axios/commits/master)
[](https://github.com/ElasticEmail/elasticemail-ts-axios/issues)
[](https://github.com/ElasticEmail/elasticemail-ts-axios/stargazers)
[Installation](#installation) •
[Quick start](#quick-start) •
[Examples](#more-examples) •
[API reference](#api-reference) •
[Models](#models) •
[Contributing](#contributing)
---
## Features
- **Transactional and bulk email.** Send single messages, bulk campaigns or CSV merge-file sends.
- **Contacts, lists and segments.** Add, update, import, export and bulk-delete contacts.
- **Campaigns and automations.** Create, update, pause and trigger automations for a contact.
- **Templates, files and attachments.** Manage templates and uploaded files.
- **Domains.** Verify sending domains and check SPF, DKIM, tracking and certificate status.
- **Webhooks and inbound routes.** Receive delivery events and route incoming mail.
- **Statistics, events and suppressions.** Track delivery, bounces, complaints and unsubscribes.
- **Subaccounts and security.** Manage subaccounts and API keys.
- **Typed and promise-based.** Every request and response has a TypeScript type, and every method returns an axios promise, so it works with `async`/`await` in TypeScript and plain JavaScript.
## Requirements
| Platform | Version |
| --- | --- |
| Node.js | Current LTS recommended (the SDK uses [axios](https://www.npmjs.com/package/axios) 1.x) |
| TypeScript | Optional. Type definitions ship with the package, no `@types` install needed |
| Browsers | Via a bundler (webpack, Vite, esbuild) |
You'll also need an Elastic Email **API key**. You can create one in your [API settings](https://app.elasticemail.com/marketing/settings/new/manage-api). Each endpoint's documentation lists the access level it needs.
## Installation
Install the [`@elasticemail/elasticemail-client-ts-axios`](https://www.npmjs.com/package/@elasticemail/elasticemail-client-ts-axios) package from npm:
```bash
npm install @elasticemail/elasticemail-client-ts-axios
```
Or with yarn or pnpm:
```bash
yarn add @elasticemail/elasticemail-client-ts-axios
pnpm add @elasticemail/elasticemail-client-ts-axios
```
npm installs the runtime dependency ([axios](https://www.npmjs.com/package/axios)) for you. The package ships compiled CommonJS and `.d.ts` files in `dist/`, so there's nothing to compile.
## Quick start
> [!IMPORTANT]
> Elastic Email only sends from verified domains. Before your first send, [verify your sending domain](https://help.elasticemail.com/en/articles/4934400-how-to-verify-your-domain) and use an address on that domain as the sender.
### Configure the client
```typescript
import { Configuration, EmailsApi } from '@elasticemail/elasticemail-client-ts-axios';
const config = new Configuration({
apiKey: process.env.ELASTICEMAIL_API_KEY,
});
const emails = new EmailsApi(config);
```
> [!TIP]
> Keep your API key out of source code. Load it from an environment variable, a `.env` file that isn't committed, or a secrets manager.
### Send a transactional email
```typescript
import { isAxiosError } from 'axios';
import { BodyContentType, EmailTransactionalMessageData } from '@elasticemail/elasticemail-client-ts-axios';
const message: EmailTransactionalMessageData = {
Recipients: {
To: ['john.doe@example.com'],
},
Content: {
From: 'My App