broadcast-api
CommunityBroadcast API integration reference docs
Software Engineering#documentation#authentication#endpoints#api-integration#subscribers#broadcast-api
Authoraniketpanjwani
Version1.0.0
Installs0
System Documentation
What problem does it solve?
The Broadcast API documentation provides a precise reference for integrating with the Broadcast email provider within the Payload Newsletter Plugin, enabling developers to understand authentication, endpoints, and expected payloads to build reliable campaigns.
Core Features & Use Cases
- Comprehensive Endpoints: List and manage broadcasts, subscribers, and related resources via RESTful endpoints with clear request/response schemas.
- Authentication & Security: Guidance on Bearer token usage, token scopes, and best practices for securing API access.
- Diagnostics & Debugging: Examples for error handling, status codes, and common pitfalls to streamline integration testing.
- Use Case: Integrate a new broadcast campaign by creating a broadcast object, associating subscribers, and triggering send operations through the API.
Quick Start
Refer to the Broadcast API references to configure your base URL and token, then begin by listing broadcasts to verify connectivity.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: broadcast-api Download link: https://github.com/aniketpanjwani/payload-plugin-email-newsletter/archive/main.zip#broadcast-api Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.