How do I install the Broadcast API skill?

Run npx skillmds@latest add tomevault-io/broadcast-api in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Broadcast API safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Broadcast API?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Broadcast API free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Broadcast API?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Broadcast API by tomevault-io — Agent Skill

Name: Broadcast API
Author: tomevault-io

Broadcast API

Reference documentation for Broadcast API (sendbroadcast.net) integration. Use when working with the Broadcast email provider, creating/updating broadcasts, managing subscribers, or debugging API issues. Use when this capability is needed.

tomevault-io 2a1495c 2 files · 4.2 KB Updated Sep 17, 2026

File contents

Authentication:

Authorization: Bearer YOUR_ACCESS_TOKEN

Base endpoints:

GET /api/v1/broadcasts - List broadcasts
POST /api/v1/broadcasts - Create broadcast
GET /api/v1/broadcasts/:id - Get broadcast
PATCH /api/v1/broadcasts/:id - Update broadcast
DELETE /api/v1/broadcasts/:id - Delete broadcast
POST /api/v1/broadcasts/:id/send_broadcast - Send broadcast
GET /api/v1/subscribers.json - List subscribers
GET /api/v1/subscribers/find.json?email= - Find subscriber
POST /api/v1/subscribers.json - Create subscriber
PATCH /api/v1/subscribers.json - Update subscriber
POST /api/v1/subscribers/unsubscribe.json - Unsubscribe
POST /api/v1/subscribers/resubscribe.json - Resubscribe

Read the appropriate reference file based on what you're working on.

401 Unauthorized:

Token expired or revoked
Token lacks required permissions (Read vs Write)
Missing Bearer prefix in Authorization header

404 Not Found:

Broadcast/subscriber doesn't exist
Wrong base URL (using sendbroadcast.net instead of your instance)

422 Unprocessable Entity:

Missing required fields (subject, body for broadcasts)
Invalid email format for subscribers
Trying to update a sent broadcast

Body format for broadcasts:

Must be valid HTML
Use <br> for line breaks, <p> for paragraphs
Don't include <html>, <head>, <body> tags - Broadcast wraps content automatically

Key configuration:

{
  baseUrl: 'https://your-broadcast-instance.com',
  token: 'your_access_token',
  fromEmail: 'newsletter@yourdomain.com',
  fromName: 'Your Name',
  replyTo: 'reply@yourdomain.com'
}

The plugin creates broadcasts in Payload first, then syncs to Broadcast on first update with content (subject + body).

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: broadcast-apidescription: Reference documentation for Broadcast API (sendbroadcast.net) integration. Use when working with the Broadcast email provider, creating/updating broadcasts, managing subscribers, or debugging API issues. Use when this capability is needed.---<objective>Provide accurate, up-to-date documentation for integrating with the Broadcast API in the Payload Newsletter Plugin.</objective><essential_principles>- Broadcast is a self-hosted email marketing platform at sendbroadcast.net- All API requests require Bearer token authentication- Base URL is your Broadcast instance domain (not sendbroadcast.net)- API responses use standard HTTP status codes</essential_principles><quick_reference>**Authentication:**```Authorization: Bearer YOUR_ACCESS_TOKEN```**Base endpoints:**- `GET /api/v1/broadcasts` - List broadcasts- `POST /api/v1/broadcasts` - Create broadcast- `GET /api/v1/broadcasts/:id` - Get broadcast- `PATCH /api/v1/broadcasts/:id` - Update broadcast- `DELETE /api/v1/broadcasts/:id` - Delete broadcast- `POST /api/v1/broadcasts/:id/send_broadcast` - Send broadcast- `GET /api/v1/subscribers.json` - List subscribers- `GET /api/v1/subscribers/find.json?email=` - Find subscriber- `POST /api/v1/subscribers.json` - Create subscriber- `PATCH /api/v1/subscribers.json` - Update subscriber- `POST /api/v1/subscribers/unsubscribe.json` - Unsubscribe- `POST /api/v1/subscribers/resubscribe.json` - Resubscribe**Broadcast statuses:**`draft` | `scheduled` | `queueing` | `sending` | `sent` | `failed` | `partial_failure` | `aborted` | `paused`</quick_reference><routing>| Topic | Reference File ||-------|----------------|| Broadcasts API (CRUD, sending, statistics) | references/broadcasts-api.md || Subscribers API (CRUD, tags, filtering) | references/subscribers-api.md || Authentication & tokens | references/authentication.md || Overview & general info | references/overview.md |Read the appropriate reference file based on what you're working on.</routing><common_issues>**401 Unauthorized:**- Token expired or revoked- Token lacks required permissions (Read vs Write)- Missing `Bearer ` prefix in Authorization header**404 Not Found:**- Broadcast/subscriber doesn't exist- Wrong base URL (using sendbroadcast.net instead of your instance)**422 Unprocessable Entity:**- Missing required fields (subject, body for broadcasts)- Invalid email format for subscribers- Trying to update a sent broadcast**Body format for broadcasts:**- Must be valid HTML- Use `<br>` for line breaks, `<p>` for paragraphs- Don't include `<html>`, `<head>`, `<body>` tags - Broadcast wraps content automatically</common_issues><integration_notes>In this plugin, the Broadcast provider is at `src/providers/broadcast/broadcast.ts`Key configuration:```typescript{ baseUrl: 'https://your-broadcast-instance.com', token: 'your_access_token', fromEmail: 'newsletter@yourdomain.com', fromName: 'Your Name', replyTo: 'reply@yourdomain.com'}```The plugin creates broadcasts in Payload first, then syncs to Broadcast on first update with content (subject + body).</integration_notes><success_criteria>- API calls use correct endpoints and methods- Authentication header is properly formatted- Request bodies match expected schema- Error responses are handled appropriately</success_criteria>---> Converted and distributed by [TomeVault](https://tomevault.io/claim/aniketpanjwani) — claim your Tome and manage your conversions.

Frequently asked questions