Broadcasts

A broadcast sends one email to every subscribed contact in a segment: a newsletter, a product announcement, a policy update.

Create a broadcast

curl https://api.jumploon.com/broadcasts \
  -H "Authorization: Bearer $JUMPLOON_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "segment_id": "<segment id>",
    "from": "Acme <news@acme.com>",
    "subject": "What\u0027s new in November",
    "html": "<p>Hi {{{FIRST_NAME|there}}},</p><p>Here\u0027s what we shipped…</p><p><a href=\"{{{UNSUBSCRIBE_URL}}}\">Unsubscribe</a></p>"
  }'

Field	Description
`segment_id`	Required. Who receives it.
`from`, `subject`	Required.
`html`, `text`	The content.
`name`	An internal name, shown in the dashboard.
`reply_to`	Reply-To addresses.
`topic_id`	Optional. Send only to contacts subscribed to this topic.

You can also write and design broadcasts in the dashboard under Broadcasts.

Personalization

Placeholder	Becomes
`{{{FIRST_NAME}}}`, `{{{LAST_NAME}}}`, `{{{EMAIL}}}`	The contact's fields
`{{{plan}}}`	Any contact property
`{{{FIRST_NAME\|there}}}`	A fallback used when the value is empty
`{{{UNSUBSCRIBE_URL}}}`	The contact's unsubscribe link

Values are HTML-escaped in the HTML part. If you don't place the unsubscribe link yourself, a footer with one is added. Every broadcast carries one-click List-Unsubscribe headers.

Send or schedule

# Send now
curl -X POST https://api.jumploon.com/broadcasts/<id>/send \
  -H "Authorization: Bearer $JUMPLOON_API_KEY"
 
# Or schedule it
curl -X POST https://api.jumploon.com/broadcasts/<id>/send \
  -H "Authorization: Bearer $JUMPLOON_API_KEY" -H "Content-Type: application/json" \
  -d '{ "scheduled_at": "in 2 hours" }'

A scheduled broadcast can be canceled with POST /broadcasts/:id/cancel until it starts sending. Broadcasts are sent in chunks of 500 and resume where they left off if anything is interrupted.

Unsubscribed and suppressed contacts are skipped automatically.

Results

The dashboard shows each broadcast's delivered, opened, clicked, bounced and unsubscribed counts. Per-recipient events are sent to your webhooks like any other email.