Docs
inbuzzed.comSign inGet an API key

Broadcasts

One message to a whole audience — newsletters, announcements, promotions. Broadcasts are drafted, tested, then started; recipients come from your contact lists.

All broadcast endpoints require a key with the broadcasts scope and a plan that includes broadcasts.

The broadcast lifecycle

  1. Draft — create the broadcast with content and target lists.
  2. Test — send a preview to yourself before anyone else sees it.
  3. Start — queue the send to every contact in the target lists (minus suppressions).
  4. Cancel — stop a running send if you need to.

Create a broadcast

POST/broadcasts
curl
curl -X POST https://api.inbuzzed.com/api/v1/esp/broadcasts \
  -H "X-Api-Key: ib_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "August newsletter",
    "subject": "What we shipped in August",
    "fromname": "Your Brand",
    "fromemail": "news@yourdomain.com",
    "rawText": "<p>Here is what is new…</p>",
    "lists": ["list_123"],
    "supplists": [],
    "when": "draft"
  }'

Request parameters

namestringrequired

Internal name shown in the dashboard — recipients never see it.

subjectstringrequired

Subject line. Supports {{variables}}.

fromemailstringrequired

Verified sender address (checked against your sender-domain policy).

rawTextstring (HTML)

HTML content of the message.

fromnamestring

Sender display name.

replytostring

Reply-To address.

returnpathstring

Bounce address.

listsstring[]

IDs of the contact lists to send to.

supplistsstring[]

Suppression list IDs to exclude.

whenstring

"draft" to hold, or a schedule for later sending.

routestring

Optional sending route override.

Send a test

POST/broadcasts/:id/test

Delivers a preview of the draft to the address you specify — always test first.

Start the send

POST/broadcasts/:id/start

Queues the broadcast to every contact in its lists. The projected recipient volume is checked against your plan's monthly send allowance before anything goes out — if the send would exceed it (and overage isn't enabled), you get a 429 with the projected total instead of a partial send.

Manage broadcasts

GET/broadcasts

Lists your broadcasts. Filter with ?search=, page with ?older=.

GET/broadcasts/:id
PATCH/broadcasts/:id
DELETE/broadcasts/:id
POST/broadcasts/:id/cancel
POST/broadcasts/:id/duplicate

Delivery stats

After a send, per-domain and per-client breakdowns are available (requires the analytics scope):

GET/broadcasts/:id/domainstats
GET/broadcasts/:id/clientstats