Resend Node.js SDK

https://github.com/resend/resend-node
Admin
Node.js library for the Resend API, enabling developers to send emails programmatically with support...
Tokens:94,884
Snippets:652
Trust Score:9.9
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### get example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Example of getting a domain by ID. Logs the domain's `status` and `records` if successful.

```typescript
const { data, error } = await resend.domains.get('domain_123');
if (data) {
  console.log(data.status, data.records);
}
```

--------------------------------

### Get a topic example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Example of retrieving a topic by ID and logging its default subscription setting.

```ts
const { data, error } = await resend.topics.get('topic_123');
if (data) {
  console.log(data.default_subscription);
}
```

--------------------------------

### Get event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of retrieving an event by name and logging its schema.

```ts
const { data, error } = await resend.events.get('user.signed_up');
if (data) {
  console.log(data.schema);
}
```

--------------------------------

### Get contact example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts.md

Example usage of the get method with an email. Logs the contact's ID and properties.

```ts
const { data, error } = await resend.contacts.get({ email: 'user@gmail.com' });
if (data) {
  console.log(data.id, data.properties);
}
```

--------------------------------

### Get log example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/logs.md

Example of retrieving a single log by ID and logging its request and response bodies.

```ts
const { data, error } = await resend.logs.get('log_123');
if (data) {
  console.log(data.request_body, data.response_body);
}
```

--------------------------------

### Get domain claim example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains-claims.md

Example of retrieving a domain claim. It calls the get method with a domain ID and logs the status and blocked_reason if data is returned.

```ts
const { data, error } = await resend.domains.claims.get('domain_123');
if (data) {
  console.log(data.status, data.blocked_reason);
}
```

--------------------------------

### Install Resend SDK

Source: https://github.com/resend/resend-node/blob/canary/readme.md

Install the Resend Node.js SDK using npm or yarn.

```bash
npm install resend
# or
yarn add resend
```

--------------------------------

### Get webhook event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example usage of the get method. Logs the event type and payload.

```ts
const { data, error } = await resend.webhooks.events.get({
  webhookId: 'wh_123',
  eventId: 'wev_456',
});
if (data) {
  console.log(data.type, data.payload);
}
```

--------------------------------

### get method usage example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Shows how to call the get method and handle the response. The response contains either an error or data; on error, the error name and status code are logged.

```typescript
const { data, error } = await resend.get<{ object: 'list'; data: [] }>('/domains');
if (error) {
  console.error(error.name, error.statusCode);
}
```

--------------------------------

### create example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Example of creating a domain with `name` and `region`. Logs each record's `record` and `value` if successful.

```typescript
const { data, error } = await resend.domains.create({
  name: 'acme.com',
  region: 'us-east-1',
});
if (data) {
  data.records.forEach((r) => console.log(r.record, r.value));
}
```

--------------------------------

### List topics example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Example of listing all topics and logging each topic's name and default subscription setting.

```ts
const { data, error } = await resend.topics.list();
if (data) {
  data.data.forEach((t) => console.log(t.name, t.default_subscription));
}
```

--------------------------------

### Get contact import example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-imports.md

Example of retrieving a contact import by ID and logging its status and counts.

```ts
const { data, error } = await resend.contacts.imports.get('ci_123');
if (data) {
  console.log(data.status, data.counts);
}
```

--------------------------------

### verify example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Example of verifying a domain by ID. Logs 'Verified' and the domain ID if successful.

```typescript
const { data, error } = await resend.domains.verify('domain_123');
if (data) {
  console.log('Verified', data.id);
}
```

--------------------------------

### Example: get template

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Fetches a template by its identifier (e.g., 'tmpl_123') and logs the status and current version ID if data exists.

```typescript
const { data, error } = await resend.templates.get('tmpl_123');
if (data) {
  console.log(data.status, data.current_version_id);
}
```

--------------------------------

### list example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Example of listing domains with a limit of 50. Logs each domain's `name` and `status` if successful.

```typescript
const { data } = await resend.domains.list({ limit: 50 });
if (data) {
  data.data.forEach((d) => console.log(d.name, d.status));
}
```

--------------------------------

### Create a topic example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Example of creating a topic with `defaultSubscription` set to `'opt_in'`. Logs the new topic's ID if successful.

```ts
const { data, error } = await resend.topics.create({
  name: 'Product updates',
  defaultSubscription: 'opt_in',
});
if (data) {
  console.log(data.id);
}
```

--------------------------------

### get method example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automation-runs.md

Calls `resend.automations.runs.get` with `automationId` and `runId`. Logs the run status and each step's status if data is returned.

```ts
const { data, error } = await resend.automations.runs.get({
  automationId: 'auto_123',
  runId: 'run_456',
});
if (data) {
  console.log(data.status, data.steps.map((s) => s.status));
}
```

--------------------------------

### List events example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of listing events with a limit and logging each event's name.

```ts
const { data } = await resend.events.list({ limit: 20 });
if (data) {
  data.data.forEach((e) => console.log(e.name));
}
```

--------------------------------

### Get a segment example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/segments.md

Example of fetching a segment by ID 'seg_123' and logging its name.

```ts
const { data, error } = await resend.segments.get('seg_123');
if (data) {
  console.log(data.name);
}
```

--------------------------------

### get example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Example of retrieving a contact property by ID. If an error occurs, logs the error name (e.g., 'missing_required_field').

```TypeScript
const { data, error } = await resend.contactProperties.get('cp_123');
if (error) {
  console.error(error.name); // e.g. 'missing_required_field'
}
```

--------------------------------

### List segments example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/segments.md

Example of listing all segments and logging each segment's name.

```ts
const { data } = await resend.segments.list();
if (data) {
  data.data.forEach((s) => console.log(s.name));
}
```

--------------------------------

### Create event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of creating a custom event with a schema definition.

```ts
const { data, error } = await resend.events.create({
  name: 'user.signed_up',
  schema: { plan: 'string', seats: 'number' },
});
```

--------------------------------

### List API keys

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/api-keys.md

Lists API keys via `GET /api-keys` with cursor pagination. The example fetches up to 50 keys and logs their names and last used timestamps.

```typescript
const { data, error } = await resend.apiKeys.list({ limit: 50 });
if (data) {
  data.data.forEach((key) => console.log(key.name, key.last_used_at));
}
```

--------------------------------

### Create webhook example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example of creating a webhook with the `resend.webhooks.create` method. The response includes `data.id` and `data.signing_secret` if successful.

```typescript
const { data, error } = await resend.webhooks.create({
  endpoint: 'https://example.com/webhook',
  events: ['email.sent', 'email.delivered'],
});
if (data) {
  console.log(data.id, data.signing_secret);
}
```

--------------------------------

### create example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Example of creating a contact property with key 'plan', type 'string', and fallbackValue 'free'. Logs the returned property ID if successful.

```TypeScript
const { data, error } = await resend.contactProperties.create({
  key: 'plan',
  type: 'string',
  fallbackValue: 'free',
});
if (data) {
  console.log(data.id);
}
```

--------------------------------

### list example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Example of listing all contact properties. Iterates over the returned data and logs each property's key, type, and fallbackValue.

```TypeScript
const { data, error } = await resend.contactProperties.list();
if (data) {
  data.data.forEach((p) => console.log(p.key, p.type, p.fallbackValue));
}
```

--------------------------------

### Get automation by ID

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automations.md

Example usage of the get method with a specific automation ID. It logs the status and number of steps if the request succeeds.

```ts
const { data, error } = await resend.automations.get('auto_123');
if (data) {
  console.log(data.status, data.steps.length);
}
```

--------------------------------

### Create domain claim example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains-claims.md

Example of creating a domain claim. It sends a POST request to /domains/claim with the domain name and logs the TXT record to add in DNS.

```ts
const { data, error } = await resend.domains.claims.create({
  name: 'acme.com',
});
if (data) {
  console.log(data.record.type, data.record.name, data.record.value); // TXT record to add in DNS
}
```

--------------------------------

### List contact imports example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-imports.md

Example of listing completed contact imports and logging each import's ID and created/failed counts.

```ts
const { data } = await resend.contacts.imports.list({ status: 'completed' });
if (data) {
  data.data.forEach((i) => console.log(i.id, i.counts.created, i.counts.failed));
}
```

--------------------------------

### get broadcast example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/broadcasts.md

Calls the get method with a broadcast ID and logs the subject and status if successful. The response includes data and error properties.

```ts
const { data, error } = await resend.broadcasts.get('bc_123');
if (data) {
  console.log(data.subject, data.status);
}
```

--------------------------------

### Example: get inbound email with cid html_format

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails-receiving.md

Example usage of `resend.emails.receiving.get` with `html_format: 'cid'`. Logs the subject and attachment count if data is returned.

```typescript
const { data, error } = await resend.emails.receiving.get('in_1234', {
  html_format: 'cid',
});
if (data) {
  console.log(data.subject, data.attachments.length);
}
```

--------------------------------

### Basic template creation example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Basic example of creating a template with `html` content and a variable. The result is awaited and destructured into `data` and `error`; if `data` exists, the template ID is logged.

```ts
const result = await resend.templates.create({
  name: 'Welcome',
  subject: 'Welcome!',
  html: '<h1>Welcome {{name}}</h1>',
  variables: [{ key: 'name', type: 'string', fallbackValue: 'there' }],
});
const { data, error } = result;
if (data) {
  console.log(data.id);
}
```

--------------------------------

### Update a topic example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Example of updating a topic's description. The `id` is required.

```ts
const { data, error } = await resend.topics.update({
  id: 'topic_123',
  description: 'Weekly digest',
});
```

--------------------------------

### Create a segment example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/segments.md

Example of creating a segment named 'Power users'. Logs the new segment's ID if successful.

```ts
const { data, error } = await resend.segments.create({ name: 'Power users' });
if (data) {
  console.log(data.id);
}
```

--------------------------------

### Replay webhook event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example usage of the replay method. Logs the replayed event ID.

```ts
const { data, error } = await resend.webhooks.events.replay({
  webhookId: 'wh_123',
  eventId: 'wev_456',
});
if (data) {
  console.log('Replayed', data.id);
}
```

--------------------------------

### List webhook events example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example usage of the list method. Logs the type and status of each event in the response.

```ts
const { data, error } = await resend.webhooks.events.list({ webhookId: 'wh_123' });
if (data) {
  data.data.forEach((e) => console.log(e.type, e.status));
}
```

--------------------------------

### Create automation example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automations.md

Example of creating an automation with a trigger, delay, and send_email step, connected in sequence. The payload is translated from camelCase to snake_case by parseAutomationToApiOptions. Logs the automation id on success.

```ts
const { data, error } = await resend.automations.create({
  name: 'Welcome flow',
  steps: [
    { key: 'trigger_1', type: 'trigger', config: { eventName: 'user.signed_up' } },
    { key: 'delay_1', type: 'delay', config: { duration: '1 hour' } },
    {
      key: 'send_1',
      type: 'send_email',
      config: { template: { id: 'tmpl_123' }, from: 'hello@example.com' },
    },
  ],
  connections: [{ from: 'trigger_1', to: 'delay_1' }, { from: 'delay_1', to: 'send_1' }],
});
if (data) {
  console.log(data.id);
}
```

--------------------------------

### Example: using ChainableTemplateResult

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Example usage of ChainableTemplateResult: either await the result directly or chain the publish call. Shows both patterns.

```ts
const result = resend.templates.create({ name: 'x', html: '<p>x</p>' });
// Either await it…
const { data, error } = await result;
// …or chain publish:
const published = await resend.templates.create(payload).publish();
```

--------------------------------

### Duplicate automation example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automations.md

Example usage of the duplicate method. It calls resend.automations.duplicate with an automation ID.

```ts
const { data } = await resend.automations.duplicate('auto_123');
```

--------------------------------

### List logs example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/logs.md

Example of listing logs with a limit of 50. Iterates over the returned log entries and logs the HTTP method, endpoint, and response status.

```ts
const { data, error } = await resend.logs.list({ limit: 50 });
if (data) {
  data.data.forEach((log) => console.log(log.method, log.endpoint, log.response_status));
}
```

--------------------------------

### Create contact import example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-imports.md

Example of creating a contact import from a CSV Blob. It sets a column map and upsert conflict handling, then logs the import ID on success.

```ts
const file = new Blob(['email,first_name\nuser@gmail.com,Foo'], { type: 'text/csv' });

const { data, error } = await resend.contacts.imports.create({
  file,
  columnMap: { email: 'email', firstName: 'first_name' },
  onConflict: 'upsert',
});
if (data) {
  console.log(data.id);
}
```

--------------------------------

### Chained publish example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Example of chaining `.publish()` after `create` with a `react` template. If `create` fails, `publish` is never called and the create error is returned.

```ts
const { data, error } = await resend.templates.create({
  name: 'Welcome',
  react: <EmailTemplate firstName="John" />, // or jsx(EmailTemplate, { ... })
}).publish();

if (error) {
  // If create failed, publish is never called and the create error is returned.
  console.error(error.name);
} else {
  console.log(`Published ${data.id}`);
}
```

--------------------------------

### Update event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of updating an event's schema by ID.

```ts
const { data, error } = await resend.events.update('event_123', {
  schema: { plan: 'string' },
});
```

--------------------------------

### Remove a topic example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Example of removing a topic and logging 'Removed' if the deletion was successful.

```ts
const { data } = await resend.topics.remove('topic_123');
if (data?.deleted) {
  console.log('Removed');
}
```

--------------------------------

### Verify domain claim example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains-claims.md

Example of verifying a domain claim. It calls the verify method with a domain ID and logs any error if present.

```ts
const { data, error } = await resend.domains.claims.verify('domain_123');
if (error) {
  console.error(error.name, error.message);
}
```

--------------------------------

### update example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Example of updating a domain by ID, disabling open tracking and enforcing TLS. Logs the error name if an error occurs.

```typescript
const { error } = await resend.domains.update({
  id: 'domain_123',
  openTracking: false,
  tls: 'enforced',
});
if (error) {
  console.error(error.name);
}
```

--------------------------------

### delete method example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Example usage of the delete method, sending a DELETE request to delete a domain. Shows error handling with console.error.

```typescript
const { data, error } = await resend.delete<{ object: 'domain'; id: string; deleted: boolean }>(
  '/domains/domain-id',
);
if (error) {
  console.error(error.name); // e.g. 'invalid_api_key'
}
```

--------------------------------

### Usage.get method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/usage.md

The `get` method takes no arguments and performs a `GET /usage` request, returning a `GetUsageResponse`.

```ts
async get(): Promise<GetUsageResponse>
```

--------------------------------

### List contacts example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts.md

Example usage of the list method with a segment ID and limit. Logs each contact's email and unsubscribed status.

```ts
const { data, error } = await resend.contacts.list({ segmentId: 'seg_123', limit: 50 });
if (data) {
  data.data.forEach((c) => console.log(c.email, c.unsubscribed));
}
```

--------------------------------

### Send event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of sending a custom event with an email target and optional payload. Logs the event name if successful.

```ts
const { data, error } = await resend.events.send({
  event: 'user.signed_up',
  email: 'user@gmail.com',
  payload: { plan: 'pro' },
});
if (data) {
  console.log(data.event);
}
```

--------------------------------

### get method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/domains.md

Signature for the `get` method. It takes a domain ID and returns a `GetDomainResponse`.

```typescript
async get(id: string): Promise<GetDomainResponse>
```

--------------------------------

### Usage.get example with error handling

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/usage.md

Example of calling `resend.usage.get()` and checking the `error` member before reading `data`. The `data` is `null` when an `ErrorResponse` occurs (e.g. `invalid_api_key`, `restricted_api_key`, `not_found`).

```ts
const { data, error } = await resend.usage.get();
if (data) {
  console.log(`Emails sent: ${data.emails.monthly.sent}/${data.emails.monthly.limit}`);
  console.log(`Contacts: ${data.contacts.used}/${data.contacts.limit}`);
} else {
  console.error(error?.name, error?.statusCode);
}
```

--------------------------------

### update example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Example of updating a contact property's fallback value to 'pro' for the property with ID 'cp_123'.

```TypeScript
const { data, error } = await resend.contactProperties.update({
  id: 'cp_123',
  fallbackValue: 'pro',
});
```

--------------------------------

### patch method example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Example usage of the patch method, sending a PATCH request to update a contact.

```typescript
const response = await resend.patch<{ id: string }>('/contacts/user@example.com', {
  first_name: 'Jane',
});
```

--------------------------------

### List contact topics example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-topics.md

Lists the topic subscriptions for a contact identified by ID. The response contains an array of `ContactTopic` objects, and the example logs each topic's name and subscription status.

```typescript
const { data, error } = await resend.contacts.topics.list({ id: 'contact_123' });
if (data) {
  data.data.forEach((t) => console.log(t.name, t.subscription));
}
```

--------------------------------

### verify basic example (Next.js App Router)

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example of verifying a webhook in a Next.js App Router route handler. It reads the raw request body and headers, calls verify, and returns a 400 on verification failure.

```typescript
import { NextResponse } from 'next/server';

export async function POST(request: Request) {
  const payload = await request.text();
  const headers = {
    id: request.headers.get('webhook-id')!,
    timestamp: request.headers.get('webhook-timestamp')!,
    signature: request.headers.get('webhook-signature')!,
  };

  try {
    const event = resend.webhooks.verify({ payload, headers, webhookSecret });
    if (event.type === 'email.delivered') {
      console.log('Delivered', event.data.email_id);
    }
    return NextResponse.json({});
  } catch (error) {
    console.error(error); // WebhookVerificationError — invalid signature
    return NextResponse.json({ error }, { status: 400 });
  }
}
```

--------------------------------

### GET /automations

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/endpoints.md

Lists all automations with pagination.

```APIDOC
## GET /automations

### Description
Lists all automations.

### Method
GET

### Endpoint
/automations

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter by status.
- **limit** (number) - Optional - Maximum number of records.
- **after** (string) - Optional - Cursor for pagination.
- **before** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **data** (PaginatedData<Automation[]>) - Paginated list of automations.

#### Response Example
{
  "data": {
    "object": "list",
    "has_more": false,
    "data": []
  }
}

### Errors
API errors.
```

--------------------------------

### get method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automation-runs.md

Declares the `get` method that retrieves a single automation run. It accepts `GetAutomationRunOptions` and returns a `GetAutomationRunResponse`.

```ts
async get(
  options: GetAutomationRunOptions,
): Promise<GetAutomationRunResponse>
```

--------------------------------

### Update automation example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/automations.md

Example usage of the update method. It calls resend.automations.update with an automation ID and a payload that sets the status to 'disabled'.

```ts
const { data, error } = await resend.automations.update('auto_123', {
  status: 'disabled',
});
```

--------------------------------

### List webhook event attempts example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example usage of the list method. It fetches attempts for a specific webhook event and logs the HTTP status code and sent timestamp for each attempt.

```ts
const { data, error } = await resend.webhooks.events.attempts.list({
  webhookId: 'wh_123',
  eventId: 'wev_456',
});
if (data) {
  data.data.forEach((a) => console.log(a.http_status_code, a.sent_at));
}
```

--------------------------------

### new Resend(key?, options?)

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Constructor for the Resend client. Initializes the client with an API key and optional configuration. Throws an error if no API key is provided and the RESEND_API_KEY environment variable is not set.

```APIDOC
## Constructor

```ts
constructor(
  readonly key?: string,
  options?: ResendOptions,
)
```

### Description
Creates a new Resend client instance. The API key can be provided directly or read from the `RESEND_API_KEY` environment variable. If neither is set, the constructor throws an error.

### Parameters
- `key` (string, optional) - The API key, e.g. `re_...`. Defaults to `process.env.RESEND_API_KEY`.
- `options` (ResendOptions, optional) - Configuration options. Defaults to `{}`.

### Example — basic

```ts
import { Resend } from 'resend';

const resend = new Resend('re_123456789');
const resendWithOptions = new Resend('re_123456789', {
  baseUrl: 'https://api.resend.com',
  userAgent: 'my-app',
});
```

### Example — error handling

```ts
import { Resend } from 'resend';

try {
  const resend = new Resend(); // no key and no RESEND_API_KEY env var
} catch (error) {
  // Error: 'Missing API key. Pass it to the constructor `new Resend("re_123")`'
  console.error(error);
}
```
```

--------------------------------

### Get suppression example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/suppressions.md

Example usage of resend.suppressions.get to retrieve a suppression by email. Logs the origin and source_id on success.

```typescript
const { data, error } = await resend.suppressions.get('bounce@example.com');
if (data) {
  console.log(data.origin, data.source_id);
}
```

--------------------------------

### Example: calling resend.emails.metrics

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails.md

Example usage of the `metrics` method with options for date range, granularity, metrics, and dimensions. It logs the `delivered` total from the response data.

```typescript
const { data, error } = await resend.emails.metrics({
  startDate: '2025-01-01',
  endDate: '2025-01-07',
  granularity: 'daily',
  metrics: ['delivered', 'opened'],
  dimensions: ['period'],
});
if (data) {
  console.log(data.totals.delivered);
}
```

--------------------------------

### Update contact example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts.md

Example usage of the update method. It updates a contact by email, setting a new first name and marking them as unsubscribed. The response is destructured into data and error.

```ts
const { data, error } = await resend.contacts.update({
  email: 'user@gmail.com',
  firstName: 'New name',
  unsubscribed: true,
});
```

--------------------------------

### clickedLinks usage example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/broadcasts.md

Example usage of clickedLinks with a broadcast ID and pagination options. Logs the URL and click count for each clicked link.

```ts
const { data } = await resend.broadcasts.clickedLinks('bc_123', { limit: 5 });
if (data) {
  data.data.forEach((l) => console.log(l.url, l.clicks));
}
```

--------------------------------

### List contact segments example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-segments.md

Example usage of the `list` method. It lists segments for a contact, with pagination options like `limit`. The response data contains an array of segments, each with a `name` property.

```ts
const { data, error } = await resend.contacts.segments.list({
  contactId: 'contact_123',
  limit: 10,
});
if (data) {
  data.data.forEach((s) => console.log(s.name));
}
```

--------------------------------

### List OAuth grants example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/oauth-grants.md

Example of listing OAuth grants using `resend.oauthGrants.list()`. It logs the client name and scopes for each grant, or logs the error name and status code on failure.

```typescript
const { data, error } = await resend.oauthGrants.list();
if (error) {
  console.error(error.name, error.statusCode); // e.g. 'invalid_api_key'
} else if (data) {
  data.data.forEach((g) => console.log(g.client.name, g.scopes));
}
```

--------------------------------

### GET /usage

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/endpoints.md

Retrieves usage information for the account.

```APIDOC
## GET /usage

### Description
Retrieves usage information for the account.

### Method
GET

### Endpoint
/usage

### Response
#### Success Response (200)
- **object** (string) - Always 'usage'.
- **quota_blocks** (array) - An array of quota blocks.

#### Response Example
{
  "object": "usage",
  "quota_blocks": []
}
```

--------------------------------

### Example: list templates

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Lists templates with a limit of 10 and logs each template's name and status.

```typescript
const { data } = await resend.templates.list({ limit: 10 });
if (data) {
  data.data.forEach((t) => console.log(t.name, t.status));
}
```

--------------------------------

### forward example — passthrough

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails-receiving.md

Example of forwarding an email in passthrough mode (default). It passes `emailId`, `to`, and `from`; the raw email is downloaded and re-sent with parsed attachments. If successful, the new email's ID is logged.

```typescript
const { data, error } = await resend.emails.receiving.forward({
  emailId: 'in_1234',
  to: 'me@example.com',
  from: 'support@example.com',
});
if (data) {
  console.log('Forwarded', data.id);
}
```

--------------------------------

### GET /templates

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/endpoints.md

Retrieves a list of templates with optional pagination.

```APIDOC
## GET /templates

### Description
Retrieves a list of templates with optional pagination.

### Method
GET

### Endpoint
/templates

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The maximum number of templates to return.
- **after** (string) - Optional - Cursor for pagination, returns templates after this ID.
- **before** (string) - Optional - Cursor for pagination, returns templates before this ID.

### Response
#### Success Response (200)
- **object** (string) - Always 'list'.
- **data** (array) - An array of template list items.
- **has_more** (boolean) - Indicates if there are more templates to fetch.

#### Response Example
{
  "object": "list",
  "data": [
    {
      "id": "template_id",
      "name": "Template Name"
    }
  ],
  "has_more": false
}
```

--------------------------------

### GET /topics

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Lists all topics. Takes no arguments and returns an array of topic objects.

```APIDOC
## GET /topics

### Description
Lists all topics. No pagination is supported.

### Method
GET

### Endpoint
/topics

### Parameters
None

### Request Example
```ts
const { data, error } = await resend.topics.list();
if (data) {
  data.data.forEach((t) => console.log(t.name, t.default_subscription));
}
```

### Response
#### Success Response (200)
- **data** (array of Topic) - List of topics. Each topic has: `id`, `name`, `description` (optional), `default_subscription` ('opt_in' | 'opt_out'), `created_at`.

#### Response Example
```ts
// data: { data: [{ id: 'topic_123', name: 'Product updates', default_subscription: 'opt_in', created_at: '...' }] }
```
```

--------------------------------

### Get webhook by ID (resend.webhooks.get)

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Retrieves a webhook by its ID. The response includes the webhook status and endpoint. The example logs the status and endpoint if data is present.

```typescript
const { data, error } = await resend.webhooks.get('wh_123');
if (data) {
  console.log(data.status, data.endpoint);
}
```

--------------------------------

### get

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Sends a GET request to the Resend API. Note: `query` is not automatically appended to the URL — callers build query strings themselves.

```APIDOC
## GET

### Description
Sends a GET request to the Resend API. Note: `query` is not automatically appended to the URL — callers build query strings themselves.

### Method
GET

### Endpoint
`{path}` (e.g., `/emails`)

### Parameters
#### Path Parameters
- `path` (string) - Required - API path, e.g., `/emails`.

#### Query Parameters
- `options.query` (object) - Optional - Query parameters to include in the request. Not automatically appended to the URL.

#### Headers
- `options.headers` (HeadersInit) - Optional - Additional headers to send with the request.

### Request Example
```ts
const { data, error } = await resend.get<{ object: 'list'; data: [] }>('/domains');
```

### Response
Returns `Promise<Response<T>>` (inferred).

#### Response Example
```ts
if (error) {
  console.error(error.name, error.statusCode);
}
```
```

--------------------------------

### Get an email by ID with resend.emails.get

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails.md

Retrieves a single email by its ID. The response includes fields such as subject and last_event, which can be one of the documented event types. The example shows how to call the method and access the returned data.

```ts
async get(id: string): Promise<GetEmailResponse>
```

```ts
const { data, error } = await resend.emails.get('em_1234');
if (data) {
  console.log(data.subject, data.last_event);
}
```

--------------------------------

### Remove contact from segment example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-segments.md

Example usage of the `remove` method. Removes a contact from a segment. The response includes a `deleted` boolean; the example logs a message when deletion succeeds.

```ts
const { data, error } = await resend.contacts.segments.remove({
  contactId: 'contact_123',
  segmentId: 'seg_456',
});
if (data?.deleted) {
  console.log('Removed from segment');
}
```

--------------------------------

### get

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/templates.md

Retrieves a template by its ID or alias.

```APIDOC
## GET /templates/{identifier}

### Description
Retrieves a template by its ID or alias.

### Method
GET

### Endpoint
/templates/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Template ID or alias.

### Request Example
```ts
const { data, error } = await resend.templates.get('tmpl_123');
if (data) {
  console.log(data.status, data.current_version_id);
}
```

### Response
#### Success Response (200)
- **object** (string) - Always 'template'.
- **Template fields** - See types.md for full shape.

#### Response Example
```json
{
  "object": "template",
  "status": "published",
  "current_version_id": "ver_123"
}
```
```

--------------------------------

### get method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Method signature for retrieving a topic by ID. Sends a GET request to `/topics/{id}`. Client-side validation returns an error if `id` is falsy.

```ts
async get(id: string): Promise<GetTopicResponse>
```

--------------------------------

### GET /logs

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/endpoints.md

Retrieves a list of logs with optional pagination.

```APIDOC
## GET /logs

### Description
Retrieves a list of logs with optional pagination.

### Method
GET

### Endpoint
/logs

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The maximum number of logs to return.
- **after** (string) - Optional - Cursor for pagination.
- **before** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **object** (string) - Always 'list'.
- **has_more** (boolean) - Indicates if there are more logs.
- **data** (array) - An array of log pick objects.

#### Response Example
{
  "object": "list",
  "has_more": false,
  "data": []
}
```

--------------------------------

### Remove event example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/events.md

Example of removing an event by ID and logging a confirmation if deletion succeeded.

```ts
const { data } = await resend.events.remove('event_123');
if (data?.deleted) {
  console.log('Deleted');
}
```

--------------------------------

### forward example — wrapped with custom text

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails-receiving.md

Example of forwarding an email in wrapped mode (`passthrough: false`) with custom text. The original raw message is attached as `forwarded_message.eml`. Includes an `idempotencyKey` in the request options. Errors are logged with name and message.

```typescript
const response = await resend.emails.receiving.forward({
  emailId: 'in_1234',
  to: 'me@example.com',
  from: 'support@example.com',
  passthrough: false,
  text: 'See the original message attached.',
}, { idempotencyKey: 'fwd-123' });

if (response.error) {
  console.error(response.error.name, response.error.message);
}
```

--------------------------------

### remove example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Example of removing a contact property by ID. Logs 'Removed' if the deletion was successful.

```TypeScript
const { data } = await resend.contactProperties.remove('cp_123');
if (data?.deleted) {
  console.log('Removed');
}
```

--------------------------------

### GET /templates/{identifier}

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/endpoints.md

Retrieves a single template by its identifier.

```APIDOC
## GET /templates/{identifier}

### Description
Retrieves a single template by its identifier.

### Method
GET

### Endpoint
/templates/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The identifier of the template.

### Response
#### Success Response (200)
- **object** (string) - Always 'template'.
- **id** (string) - The ID of the template.
- **name** (string) - The name of the template.
- **subject** (string) - The subject line.
- **html** (string) - The HTML content.
- **text** (string) - The plain text content.
- **alias** (string) - The alias.
- **from** (string) - The sender email.
- **reply_to** (string) - The reply-to email.
- **variables** (array) - The variables defined for the template.

#### Response Example
{
  "object": "template",
  "id": "template_id",
  "name": "Template Name",
  "subject": "Hello",
  "html": "<p>Hello</p>",
  "text": "Hello",
  "alias": "welcome",
  "from": "sender@example.com",
  "reply_to": "reply@example.com",
  "variables": []
}
```

--------------------------------

### Example — basic

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Basic usage of the Resend constructor with an API key and optional options. The options allow overriding the base URL and user agent.

```typescript
import { Resend } from 'resend';

const resend = new Resend('re_123456789');
const resendWithOptions = new Resend('re_123456789', {
  baseUrl: 'https://api.resend.com',
  userAgent: 'my-app',
});
```

--------------------------------

### get

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contacts-imports.md

Retrieves a single contact import by its ID. Sends a GET request to /contacts/imports/{id}.

```APIDOC
## [GET] /contacts/imports/{id}

### Description
Retrieves a single contact import by its ID.

### Method
GET

### Endpoint
/contacts/imports/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the contact import.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **object** (string) - Always 'contact_import'.
- **id** (string) - The import ID.
- **status** (string) - The import status.
- **created_at** (string) - Timestamp of creation.
- **completed_at** (string) - Timestamp of completion.
- **counts** (object) - Import counts.

#### Response Example
```json
{
  "object": "contact_import",
  "id": "ci_123",
  "status": "completed",
  "created_at": "2024-01-01T00:00:00Z",
  "completed_at": "2024-01-01T00:00:00Z",
  "counts": {
    "total": 100,
    "created": 50,
    "updated": 30,
    "skipped": 10,
    "failed": 10
  }
}
```

--------------------------------

### get

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Retrieves a single contact property by ID. Sends a GET request to /contact-properties/{id}.

```APIDOC
## GET /contact-properties/{id}

### Description
Retrieves a contact property by its ID.

### Method
GET

### Endpoint
/contact-properties/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the contact property.

### Request Example
GET /contact-properties/cp_123

### Response
#### Success Response (200)
- **object** (string) - Always 'contact_property'.
- **id** (string) - Property ID.
- **createdAt** (string) - Creation timestamp.
- **key** (string) - Property key.
- **type** (string) - Property type.
- **fallbackValue** (string | number | null) - Fallback value.

#### Response Example
{
  "object": "contact_property",
  "id": "cp_123",
  "createdAt": "2024-01-01T00:00:00Z",
  "key": "plan",
  "type": "string",
  "fallbackValue": "free"
}
```

--------------------------------

### Create API key

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/api-keys.md

Creates an API key via `POST /api-keys`. The `token` is shown only once at creation. The example creates a key with `sending_access` permission and logs the returned token.

```typescript
const { data, error } = await resend.apiKeys.create({
  name: 'Prod key',
  permission: 'sending_access',
});
if (data) {
  console.log(`Key ${data.id}: ${data.token}`);
}
```

--------------------------------

### create method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/topics.md

Method signature for creating a topic. `CreateTopicOptions` includes `name`, optional `description`, and `defaultSubscription` which is translated to `default_subscription`. Sends a POST request to `/topics`.

```ts
async create(payload: CreateTopicOptions): Promise<CreateTopicResponse>
```

--------------------------------

### post method usage example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/resend.md

Shows how to call the post method with an idempotency key and handle the response. The response contains either an error or data; on error, the error message is logged, otherwise the data id is logged.

```typescript
const response = await resend.post<{ id: string }>('/emails', {
  from: 'you@example.com',
  to: 'user@gmail.com',
  subject: 'hello',
  text: 'world',
}, { idempotencyKey: 'order-123' });

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data.id);
}
```

--------------------------------

### Remove a segment example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/segments.md

Example of deleting a segment with ID 'seg_123'. Logs 'Removed' if the deletion was successful.

```ts
const { data } = await resend.segments.remove('seg_123');
if (data?.deleted) {
  console.log('Removed');
}
```

--------------------------------

### get method signature

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/contact-properties.md

Signature for the `get` method. It takes a property ID and returns a promise of `GetContactPropertyResponse`.

```TypeScript
async get(id: string): Promise<GetContactPropertyResponse>
```

--------------------------------

### Remove suppression example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/suppressions.md

Example usage of resend.suppressions.remove to delete a suppression by email. Logs 'Removed' if the deletion was successful.

```typescript
const { data } = await resend.suppressions.remove('bounce@example.com');
if (data?.deleted) {
  console.log('Removed');
}
```

--------------------------------

### Add suppression example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/suppressions.md

Example usage of resend.suppressions.add to suppress an email. Logs the returned suppression id on success.

```typescript
const { data, error } = await resend.suppressions.add({ email: 'bounce@example.com' });
if (data) {
  console.log(data.id);
}
```

--------------------------------

### List webhooks with pagination (resend.webhooks.list)

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Lists webhooks with optional pagination options. The example passes a limit of 20 and logs each webhook's endpoint and status.

```typescript
const { data } = await resend.webhooks.list({ limit: 20 });
if (data) {
  data.data.forEach((w) => console.log(w.endpoint, w.status));
}
```

--------------------------------

### rotateSigningSecret usage example

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/webhooks.md

Example of calling rotateSigningSecret with a webhook ID. The response contains data.signing_secret on success, or an error.

```typescript
const { data, error } = await resend.webhooks.rotateSigningSecret('wh_123');
if (data) {
  console.log('New secret:', data.signing_secret);
}
```

--------------------------------

### Instantiate Resend with custom options

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/configuration.md

Creates a Resend instance with a custom baseUrl and userAgent. The key argument is optional; if omitted, the constructor falls back to process.env.RESEND_API_KEY. The constructor throws an error if neither is provided.

```ts
import { Resend } from 'resend';

const resend = new Resend('re_123', {
  baseUrl: 'http://localhost:8080',
  userAgent: 'my-service/1.0',
});
```

--------------------------------

### Example — basic

Source: https://github.com/resend/resend-node/blob/canary/_autodocs/api-reference/emails.md

Sends a simple text email and logs the returned email ID if successful. Use for basic email sending with minimal options.

```ts
const { data, error } = await resend.emails.send({
  from: 'you@example.com',
  to: ['user@gmail.com'],
  replyTo: 'you@example.com',
  subject: 'hello world',
  text: 'it works!',
});

if (data) {
  console.log(`Email ${data.id} has been sent`);
}
```
Tokens:
Raw