Broadcasts

Broadcasts are your large-scale communications designed to engage a wide audience, targeting either all your subscribers or specific segments. These include your marketing campaigns and newsletters, aimed at delivering valuable content, updates, promotions, and news.

Available Endpoints

Method	Endpoint	Name
POST	batch/broadcasts	Create Broadcasts
GET	fetch/broadcasts	Get Broadcasts

The Broadcast Model

The broadcast model contains a full set of keys that represent both the email broadcast out, Tags and segments it was addressed to, the send rate and open rate across the receipts.

Properties

Name
name
Type
string
Description
The name of the broadcast campaign.
Name
subject
Type
string
Description
The subject of the email.
Name
content
Type
string
Description
The content of the email.
Name
type
Type
string
Description
The type of email. plain for Bento's css or raw to use your own.
Name
from
Type
object
Description
key value object of the sender, must be an author in your account.
Name
inclusive_tags
Type
string
Description
A comma seperated list of tags to send to.
Name
exclusive_tags
Type
string
Description
A comma seperated list of tags you do not want the email to go to.
Name
segement_id
Type
string
Description
The segment ID for the campaign.
Name
batch_size_per_hour
Type
integer
Description
The amount of emails to send per hour to ensure the highest delivery.

GET/v1/fetch/broadcasts

Get Broadcasts

Returns a list of broadcasts in your account.

We currently don't support exporting your broadcast history directly in the app. However, this endpoint can be used to obtain a copy of all your broadcasts. This feature can be useful if you want to utilize this data in your own application, such as training language models on your writing style or creating a digest of previous content.

Name
site_uuid
Type
string
Description
Your site UUID.
Name
page
Type
integer
Description
Pagination number. If you have many broadcasts, you can paginate through them by adding the page parameter. For example, to get the second page of broadcasts add ?page=2 to the end of the url. Be be sure to continue to add the site_uuid parameter to the end of the url.

Response

Returns a collection of broadcasts and their details.

POST/v1/batch/broadcasts

Create Broadcasts

Create new broadcasts to be sent.

Required Attributes

Requires broadcasts that is an array of the broadcast object properties

Name
name
Type
string
Description
Name of the broadcast such as a campaign name.
Name
subject
Type
string
Description
Subject line of the broadcast email
Name
content
Type
string
Description
Broadcast body content, supports liquid tags.
Name
type
Type
string
Description
The type of email. plain for Bento's css or raw to use your own.
Name
from
Type
object
Description
key value object of the sender, must be an author in your account.
Name
inclusive_tags
Type
string
Description
A comma seperated list of tags to send to.
Name
exclusive_tags
Type
string
Description
A comma seperated list of tags you do not want the email to go to.
Name
segement_id
Type
string
Description
The segment ID for the campaign.
Name
batch_size_per_hour
Type
integer
Description
The amount of emails to send per hour to ensure the highest delivery.
Name
send_at
Type
datetime
Description
The date and time to send the broadcast at.
Recommended format: 2024-04-23T18:30:00Z
Name
approved
Type
boolean
Description
Whether the broadcast has been approved by Bento and will be sent at the scheduled time.
We STRONGLY recommend you only add this key after you've done a few test requests and have sent those manually.

Response

Returns the count of broadcasts queued for processing.