Broadcasts
Create and manage Broadcasts through the Resend API.
Operations
| Method | Endpoint | Description |
|---|---|---|
GET | /broadcasts | Retrieve a list of broadcasts |
POST | /broadcasts | Create a broadcast |
GET | /broadcasts/{id} | Retrieve a single broadcast |
PATCH | /broadcasts/{id} | Update an existing broadcast |
DELETE | /broadcasts/{id} | Remove an existing broadcast that is in the draft status |
POST | /broadcasts/{id}/send | Send or schedule a broadcast |
POST | /broadcasts/{id}/cancel | Cancel a broadcast |
POST | /broadcasts/{id}/duplicate | Duplicate a broadcast |
GET | /broadcasts/{id}/recipients | Retrieve broadcast recipients |
GET | /broadcasts/{id}/clicked-links | Retrieve a broadcast's clicked links |
Example
Retrieve a list of broadcasts, with the TypeScript SDK:
ts
import { Resend } from "@octridev/resend";
const client = new Resend({
// Optional: replaces the default server and any server an operation declares.
baseUrl: "https://api.resend.com",
auth: { bearerAuth: process.env.API_TOKEN! },
});
const result = await client.broadcasts.list();
console.log(result);Nine more languages
The same call exists in every SDK. See SDKs for the other nine.