Skip to content
iResendlyDocs

Broadcasts

Send a marketing email to a segment.

6 endpoints

Personalisation#

Use triple braces: {{{FIRST_NAME|there}}} (with a fallback), {{{LAST_NAME}}}, {{{EMAIL}}}, any contact property, and {{{IRESENDLY_UNSUBSCRIBE_URL}}} (or {{{UNSUBSCRIBE_URL}}}). Values are HTML-escaped in the HTML body. If the body has no unsubscribe link we add one, plus one-click List-Unsubscribe headers; plain-text bodies get an Unsubscribe: line.

  • Unsubscribed contacts and suppressed addresses are skipped.
  • A broadcast pauses itself when, after at least 100 emails, more than 5% bounce or complain. It also pauses when your quota runs out. Sending it again resumes it.

Create a broadcast

POST/broadcasts

Creates a draft. The sender's domain is checked when you send it.

Body
  • segment_idstringrequired

    The segment to send to (audience_id also works).

  • fromstringrequired

    Sender on a verified domain.

  • subjectstringrequired

    Subject line.

  • html · text · template_idstring

    The body: HTML, plain text, or a published template's id.

  • reply_tostring | string[]

    Reply-To.

  • preview_textstring

    Inbox preview, up to 500 characters.

  • namestring

    Internal name. Defaults to the subject.

POST/broadcasts
curl -X POST 'https://api.iresendly.com/broadcasts' \
  -H 'Authorization: Bearer irs_xxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "segment_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "from": "Acme <news@acme.com>",
  "subject": "November update",
  "html": "<p>Hi {{{FIRST_NAME|there}}}</p>"
}'
Response
{
  "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794"
}

Send a broadcast

POST/broadcasts/{id}/send

Sends a draft (or resumes a paused broadcast) now, or at scheduled_at. The segment needs at least one subscribed contact.

Path parameters
  • idstringrequired

    The broadcast id.

Body
  • scheduled_atstring

    ISO 8601 or in ….

POST/broadcasts/{id}/send
curl -X POST 'https://api.iresendly.com/broadcasts/{id}/send' \
  -H 'Authorization: Bearer irs_xxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "scheduled_at": "in 1 hour"
}'
Response
{
  "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794"
}

Retrieve a broadcast

GET/broadcasts/{id}

Status, content and delivery counts.

Path parameters
  • idstringrequired

    The broadcast id.

GET/broadcasts/{id}
curl -X GET 'https://api.iresendly.com/broadcasts/{id}' \
  -H 'Authorization: Bearer irs_xxxxxxxxx'
Response
{
  "object": "broadcast",
  "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794",
  "name": "November update",
  "audience_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "status": "sent",
  "stats": {
    "recipients": 1204,
    "sent": 1204,
    "failed": 0
  }
}

Update a broadcast

PATCH/broadcasts/{id}

Drafts only.

Path parameters
  • idstringrequired

    The broadcast id.

PATCH/broadcasts/{id}
curl -X PATCH 'https://api.iresendly.com/broadcasts/{id}' \
  -H 'Authorization: Bearer irs_xxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "November update (final)"
}'
Response
{
  "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794"
}

List broadcasts

GET/broadcasts

Newest first.

Query parameters
  • limitnumber

    Results per page, 1–100. Default 20.

  • afterstring

    Return results after this id (next page).

  • beforestring

    Return results before this id (previous page). Don't send with after.

GET/broadcasts
curl -X GET 'https://api.iresendly.com/broadcasts' \
  -H 'Authorization: Bearer irs_xxxxxxxxx'
Response
{
  "object": "list",
  "has_more": false,
  "data": []
}

Delete or cancel a broadcast

DELETE/broadcasts/{id}

Deletes a draft, or cancels one that's scheduled, queued or paused. Broadcasts that are sending or sent can't be deleted (422).

Path parameters
  • idstringrequired

    The broadcast id.

DELETE/broadcasts/{id}
curl -X DELETE 'https://api.iresendly.com/broadcasts/{id}' \
  -H 'Authorization: Bearer irs_xxxxxxxxx'
Response
{
  "object": "broadcast",
  "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794",
  "deleted": true
}
Still stuck? Write to us and we'll reply by email.Contact ussupport@iresendly.com