---
title: "openemail.broadcasts"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://openemail.uk/docs/sdk/reference/broadcasts"
area: "SDK"
category: "Reference"
---

# openemail.broadcasts

Every method in this namespace: its signature, its parameters, what it returns and an example.

## Methods

One message sent to everybody in one or more audiences, a personalised copy for each person, with unsubscribe handled for you.

### `broadcasts.preview()`

Count who a broadcast to some audiences would reach

```ts
preview(body: BroadcastPreviewInput, options?: RequestScope): Promise<BroadcastPreviewResource>
```

Returns the numbers `send` would work from, without sending or writing anything: `recipients`, the people a broadcast to these audiences would reach now, `unsubscribed`, the contacts skipped because they have unsubscribed from every one of these audiences they are in, and `suppressed`, the subscribed contacts skipped because their address is on the suppression list. A contact in several of the audiences counts once.

The count is taken at the moment of the call, so contacts who join or leave before a send change it. Only `audienceIds` is sent, so you can pass the same object you are about to give `send`.

Scopes: `audiences:read`.

**Parameters**

- `body.audienceIds` (`Array<string>`, required): 1 to 10 audience ids. One that names no audience in the workspace is a 404 `audience_not_found`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`BroadcastPreviewResource` with `audienceIds` as sent, `recipients`, `unsubscribed` and `suppressed`.

**Example**

```ts
const draft = {
    audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71', 'aud_7e3d9a1c5b2f84e06d9a3c51'],
    from: 'Acme <news@acme.com>',
    subject: 'The September release',
    text: 'Hi {{firstName|there}}, here is what changed this month.'
}

const reach = await openemail.broadcasts.preview(draft)

console.log(`${reach.recipients} will get it, ${reach.unsubscribed} unsubscribed, ${reach.suppressed} suppressed`)

if (reach.recipients > 0) await openemail.broadcasts.send(draft)
```

**Notes**

- Needs only `audiences:read`, so a key that cannot send can still show somebody the count.
- The SDK retries it after a network failure or a retryable status, since it changes nothing.

Also available in: API [`POST /broadcasts/preview`](https://openemail.uk/docs/api/reference/broadcasts#post-broadcasts-preview); CLI [`openemail broadcasts preview`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-preview).

### `broadcasts.send()`

Send one message to everybody in one or more audiences

```ts
send(body: BroadcastCreate, options?: SendScope): Promise<SentBroadcastResource>
```

Creates a broadcast: one message sent to every contact in the audiences you name, as a separate copy for each person. Every copy has exactly one recipient and no cc or bcc, so nobody sees who else it went to, and every copy is an ordinary email with its own `msg_` id, events, tracking and webhooks. `emails.list({ broadcastId })` lists them. Copies are not filed in the Sent folder, because the broadcast is the record.

The promise settles straight away with the broadcast `queued`, or `scheduled` when you pass `scheduledAt`, and the sending happens in the background, 50 people at a time. Poll `get` to follow `status` and `counts` as it goes.

Who gets it: every contact in at least one of `audienceIds`, counted once however many of them hold it, except a contact that has unsubscribed from every one of those audiences it is in, and except an address on the suppression list. A contact added to one of the audiences after this call but before the sending reaches it is included. `counts.recipients` is the estimate taken at the call, and `preview` returns the same count without sending.

`subject`, `html` and `text` take merge fields, filled in from each contact: `{{firstName}}`, `{{lastName}}`, `{{name}}`, `{{email}}` and `{{unsubscribeUrl}}`. Each takes a fallback after a bar, so `{{firstName|there}}` reads there for a contact with no name. The first name is the first word of the contact's name and the last name is the rest. Values are escaped in `html`, and any other `{{…}}` is left as written. With `template`, the same values are passed as props, but only the ones the template declares.

Every copy carries the one-click unsubscribe headers mail clients and the large mailbox providers look for. An `html` or `text` body that does not place `{{unsubscribeUrl}}` itself gets a one-line footer with the link, while a template is sent as it is, so put `{{unsubscribeUrl}}` in the template. Following the link marks the person unsubscribed in every audience this broadcast went to; their other audiences, their contact and mail sent to them one message at a time are not affected.

The whole send is checked against the plan's monthly sends before anything is written. A broadcast the allowance cannot cover throws 429 `send_quota_exceeded` and leaves nothing behind, and each copy counts as one send.

Scopes: `emails:send`, `audiences:read`.

**Parameters**

- `body.audienceIds` (`Array<string>`, required): 1 to 10 audience ids such as `aud_9f2c4b7e1a0d63d84c5f2e7b`. A contact in several of them gets one copy. An id that names no audience in the workspace is a 404 `audience_not_found` and nothing is sent.
- `body.from` (`RecipientInput`, required): Sender as `news@acme.com`, `Acme <news@acme.com>` or `{ email, name }`. It must be an address the key may send as, otherwise 403 `from_address_forbidden`.
- `body.replyTo` (`RecipientInput`): Where replies go, the same for every copy.
- `body.subject` (`string`): Required unless a template supplies it, at most 998 characters. Takes merge fields.
- `body.html` (`string`): HTML body, at most 1,000,000 characters, with merge fields. Without `{{unsubscribeUrl}}` in it an unsubscribe footer is added.
- `body.text` (`string`): Plain text body, at most 1,000,000 characters, with merge fields. Without `{{unsubscribeUrl}}` in it an unsubscribe line is added.
- `body.template` (`{ id: string, version?: number, props?: Record<string, unknown>, slots?: Record<string, unknown> }`): A stored template instead of `html` and `text`, never beside them. The merge values reach it as props it declares, such as `firstName` and `unsubscribeUrl`.
- `body.tracking` (`{ opens?: boolean, clicks?: boolean }`): Open and link tracking for every copy. A field left out follows the address it is sent from when that address set it, and is on otherwise.
- `body.tags` (`Record<string, string>`): Up to 8 tags, keys of 1 to 64 letters, digits, `_` or `-`, values up to 256 characters. Every copy carries them, plus `broadcast_id`, which the server adds.
- `body.scheduledAt` (`Date | string`): A `Date`, an ISO 8601 instant or a duration such as `PT2H` or `P1D`, in the future and at most 365 days out. Left out, the sending starts straight away.
- `options.idempotencyKey` (`string`): Your own key, 1 to 255 characters of letters, digits, `_`, `.`, `:` or `-`. Left out, the SDK makes one for the call, so its own retries never send twice. Sending the same key again answers with the broadcast it created instead of a new one; the same key with a different body is a 422 `idempotency_key_reuse`.
- `options.signal` (`AbortSignal`): Cancels the HTTP request. An aborted call may still have created the broadcast; call again with the same `idempotencyKey` to find out without sending twice.
- `options.apiKey` (`string`): Sends with this key instead of the client's.

**Returns**

`SentBroadcastResource`, a `BroadcastResource` plus `replayed`, with `id` (`brd_` plus 24 hex), `status` `queued` or `scheduled`, `audienceIds`, `from`, `subject`, `scheduledAt`, `createdAt` and `counts`, whose `recipients` is the estimate and whose other counts start at 0.

**Example**

```ts
const broadcast = await openemail.broadcasts.send({
    audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71'],
    from: 'Acme <news@acme.com>',
    subject: '{{firstName|Hello}}, the September release is out',
    html: '<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p><p><a href="{{unsubscribeUrl}}">Unsubscribe</a></p>',
    text: 'Hi {{firstName|there}},\n\nHere is what changed this month.\n\nUnsubscribe: {{unsubscribeUrl}}',
    tags: { campaign: 'release-2026-09' },
    scheduledAt: 'PT2H'
})

console.log(broadcast.id, broadcast.status, broadcast.replayed, broadcast.counts.recipients)
```

**Notes**

- Safe to retry. Every call carries an `Idempotency-Key`, yours or one the SDK makes, so a retry after a network failure answers with the broadcast the first attempt created, with `replayed: true`, instead of sending again. Keys are scoped to the API key or app that sent them. Reusing a key with a different body is a 422 `idempotency_key_reuse`.
- Refusals: 422 `no_recipients` when the audiences are empty or everybody in them has unsubscribed or is suppressed, 409 `domain_not_sendable` when the `from` domain cannot sign mail yet, 422 on `template.*` when the template does not resolve.
- No attachments, cc, bcc, translation or encryption. A body from `html` or `text` and a `template` together are refused.
- A test key (`oe_test_`) creates a broadcast whose copies are marked sent and delivered to nobody, like any test send.

Also available in: API [`POST /broadcasts`](https://openemail.uk/docs/api/reference/broadcasts#post-broadcasts); CLI [`openemail broadcasts send`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-send).

### `broadcasts.list()`

List one page of broadcasts, newest first

```ts
list(options?: BroadcastListOptions): Promise<Page<BroadcastResource>>
```

Returns one page of the broadcasts in the workspace, newest first, each with live `counts`. `audienceId` keeps the ones that were sent to that audience, alone or beside others.

Paging is keyset: `options.limit` takes 1 to 100 and defaults to 25, and `nextCursor`, the id of the last broadcast on the page, goes back as `options.cursor` while `hasMore` is true. Send the same `audienceId` with every page. `listAll` and `iterate` do that walk for you.

The individual messages are not here. List the copies of one broadcast with `emails.list({ broadcastId })`.

Scopes: `emails:read`.

**Parameters**

- `options.audienceId` (`string`): Only the broadcasts that included this audience. An id that names no audience answers an empty page.
- `options.limit` (`number`): Rows per page, a whole number from 1 to 100. The server defaults to 25.
- `options.cursor` (`string`): The `nextCursor` from the previous page, a broadcast id. One that names no broadcast in the workspace is a 400 `invalid_cursor`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`Page<BroadcastResource>` with `items`, `hasMore` and `nextCursor`. Each item has `id`, `status`, `audienceIds`, `from`, `subject`, `counts` and the timestamps.

**Example**

```ts
const page = await openemail.broadcasts.list({ audienceId: 'aud_4c1b8e2a7d9f05c36b4e8a71', limit: 10 })

for (const broadcast of page.items) {
    console.log(broadcast.createdAt, broadcast.subject, broadcast.status, `${broadcast.counts.sent}/${broadcast.counts.recipients}`)
}
```

**Notes**

- A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.

Also available in: API [`GET /broadcasts`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts); CLI [`openemail broadcasts list`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-list).

### `broadcasts.listAll()`

Collect every broadcast into one array

```ts
listAll(options?: BroadcastListOptions): Promise<Array<BroadcastResource>>
```

Follows `nextCursor` from page to page and resolves with every broadcast in the workspace, newest first, or every one sent to `audienceId` when you pass it. `limit` sets the page size of each request, not the total.

Scopes: `emails:read`.

**Parameters**

- `options.audienceId` (`string`): Only the broadcasts that included this audience.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A broadcast id to start after.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk.
- `options.apiKey` (`string`): Overrides the client's API key for every page of this walk.

**Returns**

`Array<BroadcastResource>` holding every broadcast across all pages.

**Example**

```ts
const broadcasts = await openemail.broadcasts.listAll({ limit: 100 })

const sent = broadcasts.reduce((total, broadcast) => total + broadcast.counts.sent, 0)

console.log(`${broadcasts.length} broadcasts, ${sent} copies sent`)
```

**Notes**

- A failure on any page rejects the whole call.
- Every row carries live counts, so collecting a long history reads the copies of every broadcast in it. Use `iterate` to stop early.
- A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.

Also available in: API [`GET /broadcasts`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts).

### `broadcasts.iterate()`

Stream broadcasts one at a time, newest first

```ts
iterate(options?: BroadcastListOptions): AsyncGenerator<BroadcastResource, void, undefined>
```

Returns an async generator that yields broadcasts individually, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests, so this is the cheap way to find the latest broadcast that matches something the filters cannot express.

Scopes: `emails:read`.

**Parameters**

- `options.audienceId` (`string`): Only the broadcasts that included this audience.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A broadcast id to start after.
- `options.signal` (`AbortSignal`): Cancels the request in flight and ends the iteration with an error.
- `options.apiKey` (`string`): Overrides the client's API key for every page of this walk.

**Returns**

`AsyncGenerator<BroadcastResource, void, undefined>` yielding one broadcast per step.

**Example**

```ts
for await (const broadcast of openemail.broadcasts.iterate()) {
    if (broadcast.status === 'sending') {
        console.log('still going:', broadcast.id, broadcast.counts.queued, 'waiting')
        break
    }
}
```

**Notes**

- The generator is lazy, so an abandoned loop costs only the pages you consumed.
- A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.

Also available in: API [`GET /broadcasts`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts).

### `broadcasts.get()`

Read one broadcast and how far it has got

```ts
get(id: string, options?: RequestScope): Promise<BroadcastResource>
```

Returns one broadcast with `counts` read live from its copies, which makes this the call to poll while it sends.

`status` moves from `scheduled` or `queued` to `sending` and settles on `sent` once every copy handed over has gone out or failed. It reads `sending` for as long as copies are still waiting, even after the last person was reached and `completedAt` was set. `cancelled` and `failed` are the other two ends, and on `failed` `lastError` says why: the `from` address can no longer be sent from, the template stopped resolving, the plan ran out part way, the sending itself kept failing, or not one copy could be written.

`counts.recipients` is the estimate taken when it was created. `created` is the copies written, one per person reached, `skipped` the people passed over because their address was suppressed by then, and `failedToQueue` the people whose copy could not be written. `queued`, `sending`, `sent`, `failed` and `cancelled` count the copies by the state each one is in now.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`BroadcastResource` with `id`, `status`, `mode`, `source`, `audienceIds`, `from`, `subject`, `counts`, `lastError`, `scheduledAt`, `startedAt`, `completedAt`, `cancelledAt`, `createdAt` and `updatedAt`.

**Example**

```ts
const settled = new Set(['sent', 'cancelled', 'failed'])

let broadcast = await openemail.broadcasts.get('brd_5a8c1e3f7b2d94a06c8e1f3b')

while (!settled.has(broadcast.status)) {
    await new Promise((resolve) => setTimeout(resolve, 5_000))
    broadcast = await openemail.broadcasts.get(broadcast.id)

    console.log(`${broadcast.counts.sent} of ${broadcast.counts.recipients} sent`)
}

console.log(broadcast.status, broadcast.lastError)
```

**Notes**

- A missing broadcast throws `OpenEmailApiError` with `isNotFound` true and code `broadcast_not_found`. An id from another workspace is a 404 too.
- For who each copy went to and what happened to it, use `listRecipients`, `getRecipient` reads one copy with its content, and `stats` sums it up.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id); CLI [`openemail broadcasts get`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-get).

### `broadcasts.stats()`

Read how a broadcast performed

```ts
stats(id: string, options?: BroadcastStatsOptions): Promise<BroadcastStatsResource>
```

Resolves with the totals and a series for one broadcast. `totals` counts copies `sent`, `delivered`, `bounced`, `complained` (reported as spam) and `failed`, `pending` for the ones still waiting, and people who `opened`, `clicked` and `unsubscribed`, with `opens` and `clicks` as event counts. `series` is sparse and oldest first: one bucket per `grain` in which something happened, counting each person once at the first time it happened to them, so it adds up to the totals.

Pass `days` or `minutes` to also read what happened lately. `window` then counts the copies delivered, bounced, reported as spam, opened, clicked and unsubscribed inside it, and `series` keeps only its buckets, while `totals` still covers the whole broadcast. Without either, `window` is null.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `options.grain` (`TrackingGrain`): Bucket width: `minute`, `hour` or `day`, defaulting to `hour`.
- `options.offsetMinutes` (`number`): Minutes east of UTC to cut the buckets in, from -840 to 840. Pass `-new Date().getTimezoneOffset()` for the local zone.
- `options.days` (`number`): Reads a window of this many days too, from 1 to 1095. It starts at the beginning of its first `grain` bucket and ends now.
- `options.minutes` (`number`): The window in minutes, from 1 to 1576800, which wins over `days` when both are sent.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`BroadcastStatsResource` with `broadcastId`, `grain`, `totals`, `window` and `series`, each bucket `{ bucket, delivered, opened, clicked, unsubscribed }`. `window` is `{ since, delivered, bounced, complained, opened, clicked, unsubscribed }`, or null when no window was asked for.

**Example**

```ts
const stats = await openemail.broadcasts.stats('brd_5a8c1e3f7b2d94a06c8e1f3b', { grain: 'day' })

const rate = stats.totals.sent ? stats.totals.opened / stats.totals.sent : 0

console.log(`${Math.round(rate * 100)}% opened`)
```

**Notes**

- Read only, so the SDK retries it after a network failure like any other read.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}/stats`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id-stats); CLI [`openemail broadcasts stats`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-stats).

### `broadcasts.analytics()`

Read how broadcasts did over a time window

```ts
analytics(options?: BroadcastAnalyticsOptions): Promise<BroadcastAnalyticsResource>
```

Returns the numbers behind the Analytics tab of the Broadcasts page in one request: how the live broadcasts sent inside a window did, added up in `totals` and cut to `grain` in `series`, and one row per broadcast in `broadcasts` so they can be compared.

A copy counts when it was sent inside the window, and everything that happened to it afterwards counts with it, so an open today of a copy sent last week is in a 30 day window but not in a 1 day one. Test mode broadcasts are left out. `totals` and `series` add up the broadcasts named in `broadcastIds`, or every one when it is left out, while `broadcasts` always lists every broadcast in the window, newest first.

`series` is sparse and oldest first: a bucket in which nothing happened has no entry, so a chart must fill the gaps. It counts each person once, at the first time it happened to them. `grain` sets the bucket width and the key shape, `YYYY-MM-DD`, `YYYY-MM-DDTHH` or `YYYY-MM-DDTHH:MM`, and `offsetMinutes` shifts the boundaries so days break where the reader's day does. The window starts at the beginning of its oldest bucket, reported as `since`, and ends now, reported as `until`.

Scopes: `emails:read`.

**Parameters**

- `options.broadcastIds` (`Array<string>`): Up to 50 broadcast ids for `totals` and `series` to add up, sent comma separated. Leave it out, or pass an empty array, for every broadcast in the window. An id with no copy in the window adds nothing, and more than 50 is a 422.
- `options.days` (`number`): Window length in days, from 1 to 1095, defaulting to 30.
- `options.minutes` (`number`): Window length in minutes, from 1 to 1576800, which wins over `days` when both are sent.
- `options.grain` (`TrackingGrain`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`.
- `options.offsetMinutes` (`number`): Minutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass `-new Date().getTimezoneOffset()` for the local zone.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`BroadcastAnalyticsResource`, `{ object: 'broadcast_analytics', since, until, grain, offsetMinutes, broadcastIds, totals, series, broadcasts }`. `totals` has `broadcasts` and the counts `BroadcastStatsTotals` has, each entry of `series` is `{ bucket, sent, delivered, opened, clicked, unsubscribed }`, and each entry of `broadcasts` has `id`, `subject`, `status`, `sentAt` and the same counts.

**Example**

```ts
const analytics = await openemail.broadcasts.analytics({
    days: 90,
    offsetMinutes: -new Date().getTimezoneOffset()
})

const rate = analytics.totals.delivered ? analytics.totals.opened / analytics.totals.delivered : 0

console.log(`${analytics.totals.broadcasts} broadcasts, ${Math.round(rate * 100)}% opened`)

for (const row of analytics.broadcasts) {
    console.log(row.subject, row.sent, row.opened, row.clicked)
}
```

**Notes**

- Read only, so the SDK retries it after a network failure like any other read.
- `opened`, `clicked` and `unsubscribed` count people, while `opens` and `clicks` count events.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds, and the rest are left out as if they did not exist.

Also available in: API [`GET /broadcasts/analytics`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-analytics); CLI [`openemail broadcasts analytics`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-analytics).

### `broadcasts.listRecipients()`

List who a broadcast went to and what happened to each copy

```ts
listRecipients(id: string, options?: BroadcastRecipientListOptions): Promise<Page<BroadcastRecipientResource>>
```

Resolves one page of the people a broadcast went to, one row per copy, sorted by address. Each row says the copy's status, when it was sent and delivered, whether it bounced or was reported as spam, how often it was opened and clicked, and whether the person unsubscribed from one of the broadcast's audiences after it went out.

Opens and clicks leave out image proxies and link scanners, and stay 0 when the broadcast went out with tracking off. `emailId` is the copy's `msg_` id, which `getRecipient` reads with its content and `emails.get` reads as a sent email.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `options.filter` (`BroadcastRecipientFilter`): Keeps one group: `pending`, `sent`, `delivered`, `opened`, `not_opened` (sent and never opened), `clicked`, `bounced`, `complained`, `failed` (failed or cancelled) or `unsubscribed`. `BROADCAST_RECIPIENT_FILTERS` names them.
- `options.q` (`string`): Searches the address and the name, ignoring case.
- `options.limit` (`number`): Page size, from 1 to 200. The server defaults to 50.
- `options.cursor` (`string`): The `nextCursor` of the previous page. Send the same `filter` and `q` with it.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`Page<BroadcastRecipientResource>` with `items`, `hasMore` and `nextCursor`. Each item has `emailId`, `contactId`, `email`, `name`, `status`, `sentAt`, `deliveredAt`, `bouncedAt`, `complainedAt`, `failure`, `opens`, `firstOpenAt`, `clicks`, `firstClickAt` and `unsubscribedAt`.

**Example**

```ts
const page = await openemail.broadcasts.listRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'bounced' })

for (const copy of page.items) console.log(copy.email, copy.bouncedAt)
```

**Notes**

- A missing broadcast throws `OpenEmailApiError` with code `broadcast_not_found`.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}/recipients`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id-recipients); CLI [`openemail broadcasts list-recipients`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-list-recipients).

### `broadcasts.listAllRecipients()`

Collect everybody a broadcast went to into one array

```ts
listAllRecipients(id: string, options?: BroadcastRecipientListOptions): Promise<Array<BroadcastRecipientResource>>
```

Walks every page of `listRecipients` and resolves with every copy of the broadcast, sorted by address. One request per page, with the same `filter` and `q` on each.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `options.filter` (`BroadcastRecipientFilter`): Keeps one group: `pending`, `sent`, `delivered`, `opened`, `not_opened` (sent and never opened), `clicked`, `bounced`, `complained`, `failed` (failed or cancelled) or `unsubscribed`. `BROADCAST_RECIPIENT_FILTERS` names them.
- `options.q` (`string`): Searches the address and the name, ignoring case.
- `options.limit` (`number`): Page size for each request, from 1 to 200. The server defaults to 50.
- `options.cursor` (`string`): Starts the walk after this cursor instead of the first page.
- `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it.
- `options.apiKey` (`string`): Overrides the client API key for every page of this walk.

**Returns**

`Array<BroadcastRecipientResource>` holding every copy that matches.

**Example**

```ts
const unopened = await openemail.broadcasts.listAllRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'not_opened' })

console.log(unopened.map((copy) => copy.email))
```

**Notes**

- If any page fails the promise rejects and the rows already fetched are discarded.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}/recipients`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id-recipients).

### `broadcasts.iterateRecipients()`

Walk everybody a broadcast went to, one copy at a time

```ts
iterateRecipients(id: string, options?: BroadcastRecipientListOptions): AsyncGenerator<BroadcastRecipientResource, void, undefined>
```

Yields every copy of the broadcast one at a time, fetching the next page only when the loop asks for it, sorted by address. Breaking out of the loop stops the requests.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `options.filter` (`BroadcastRecipientFilter`): Keeps one group: `pending`, `sent`, `delivered`, `opened`, `not_opened` (sent and never opened), `clicked`, `bounced`, `complained`, `failed` (failed or cancelled) or `unsubscribed`. `BROADCAST_RECIPIENT_FILTERS` names them.
- `options.q` (`string`): Searches the address and the name, ignoring case.
- `options.limit` (`number`): Page size for each request, from 1 to 200. The server defaults to 50.
- `options.cursor` (`string`): Starts after this cursor instead of the first page.
- `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it.
- `options.apiKey` (`string`): Overrides the client API key for every page of this walk.

**Returns**

`AsyncGenerator<BroadcastRecipientResource, void, undefined>` yielding one copy per step.

**Example**

```ts
for await (const copy of openemail.broadcasts.iterateRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'clicked' })) {
    console.log(copy.email, copy.clicks)
}
```

**Notes**

- Memory stays flat however large the broadcast, because only one page is held at a time.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}/recipients`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id-recipients).

### `broadcasts.getRecipient()`

Read one person's copy of a broadcast

```ts
getRecipient(id: string, emailId: string, options?: RequestScope): Promise<BroadcastRecipientContentResource>
```

Resolves with one copy: the same row `listRecipients` gives, plus the `subject`, `html` and `text` exactly as that person received them, with the merge fields filled in and their own unsubscribe link. The HTML is from before open and click tracking was added.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): A `brd_` id from `send` or `list`.
- `emailId` (`string`, required): The `emailId` of the copy, from `listRecipients`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`BroadcastRecipientContentResource`: `emailId`, `contactId`, `email`, `name`, `status`, `sentAt`, `deliveredAt`, `bouncedAt`, `complainedAt`, `failure`, `opens`, `firstOpenAt`, `clicks`, `firstClickAt` and `unsubscribedAt`, plus `subject`, `html` and `text`.

**Example**

```ts
const copy = await openemail.broadcasts.getRecipient('brd_5a8c1e3f7b2d94a06c8e1f3b', 'msg_01dad25067bc4dac966d515d')

console.log(copy.subject, copy.deliveredAt)
```

**Notes**

- An `emailId` that is not a copy of this broadcast throws with code `recipient_not_found`.
- A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`GET /broadcasts/{id}/recipients/{emailId}`](https://openemail.uk/docs/api/reference/broadcasts#get-broadcasts-id-recipients-emailid); CLI [`openemail broadcasts get-recipient`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-get-recipient).

### `broadcasts.cancel()`

Stop a broadcast that is scheduled, queued or still sending

```ts
cancel(id: string, options?: RequestScope): Promise<BroadcastResource>
```

Stops a broadcast that is `scheduled`, `queued` or `sending`, including one that has reached everybody while some copies are still waiting to go. Nobody else is added, and every copy still waiting is cancelled. A copy already being handed over finishes, and copies that have gone cannot be recalled, so `counts.sent` keeps them and `counts.cancelled` shows what was stopped.

Once every copy has gone out there is nothing left to stop, and the call throws 409 `broadcast_not_cancellable`. A `failed` broadcast with copies still waiting can be cancelled to stop them, and one with nothing waiting is refused the same way. Cancelling a broadcast that is already cancelled resolves with it as it stands, so the call is safe to repeat, and the SDK retries it after a network failure.

Scopes: `emails:send`.

**Parameters**

- `id` (`string`, required): The `brd_` id to cancel.
- `options.signal` (`AbortSignal`): Cancels the HTTP request, not the broadcast. Read it with `get` if you abort.
- `options.apiKey` (`string`): Cancels with this key instead of the client's.

**Returns**

`BroadcastResource` in its new state, `status` `cancelled` with `cancelledAt` set and the copies counted by where each one ended up.

**Example**

```ts
const scheduled = await openemail.broadcasts.send({
    audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71'],
    from: 'news@acme.com',
    subject: 'Doors open on Friday',
    text: 'Hi {{firstName|there}}, doors open at nine.',
    scheduledAt: 'P1D'
})

const cancelled = await openemail.broadcasts.cancel(scheduled.id)

console.log(cancelled.status, cancelled.counts.cancelled)
```

**Notes**

- Cancelling a scheduled broadcast before `scheduledAt` sends nothing at all.
- A cancelled broadcast stays cancelled. There is no resume, so send again to the audiences that still need it.
- A key limited to particular addresses or domains cancels only broadcasts sent from an address or domain it holds. Any other id throws `broadcast_not_found`, as if the broadcast did not exist.

Also available in: API [`POST /broadcasts/{id}/cancel`](https://openemail.uk/docs/api/reference/broadcasts#post-broadcasts-id-cancel); CLI [`openemail broadcasts cancel`](https://openemail.uk/docs/cli/reference/broadcasts#broadcasts-cancel).