Bento
View markdown

Broadcasts

Broadcasts are one-time marketing sends to a broad audience or a saved segment. Use the API to review broadcast history, create campaigns, and schedule approved sends with explicit audience rules.

Available Endpoints

MethodEndpointCopy
GET
/fetch/broadcasts

Get Broadcasts

List broadcast history and draft/scheduled broadcast metadata.

POST
/batch/broadcasts

Create Broadcasts

Create a broadcast campaign for a segment or tag audience.

The Broadcast Model

The broadcast model describes the email itself, the tags and segments it was sent to, and its send rate and open rate.

Properties

  • Name
    namestring
    Description

    The name of the broadcast campaign.

  • Name
    subjectstring
    Description

    The subject of the email.

  • Name
    contentstring
    Description

    The content of the email.

  • Name
    typestring
    Description

    The type of email. plain for Bento's CSS or raw to use your own.

  • Name
    fromobject
    Description

    A key/value object for the sender. Must be an author in your account.

  • Name
    inclusive_tagsstring
    Description

    A comma separated list of tags to send to.

  • Name
    exclusive_tagsstring
    Description

    A comma separated list of tags you do not want the email to go to.

  • Name
    segment_idstring
    Description

    The segment ID for the campaign.

  • Name
    batch_size_per_hourinteger
    Description

    The number 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.

The app does not support exporting broadcast history directly. Use this endpoint to get a copy of all your broadcasts instead.
  • Name
    site_uuidstring
    Description

    Your site UUID.

  • Name
    pageinteger
    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 sure to continue to add the site_uuid parameter to the end of the url.

  • Name
    statusstring
    Description

    Optional status filter. Supported values are sent, draft, sending, scheduled, paused, and canceled.

    If omitted, Bento defaults to sent. cancelled is also accepted as an alias for canceled. Unsupported values also fall back to sent.

Response

Returns a collection of broadcasts and their details.

The example response below shows a draft broadcast. Draft broadcasts only return template.template_id. Other broadcast statuses return the full template payload, including subject, to, and html.

  • Name
    dataarray
    Description

    Broadcast records.

  • Name
    data[].idstring
    Description

    Broadcast identifier.

  • Name
    data[].namestring
    Description

    Broadcast campaign name.

  • Name
    data[].statusstring
    Description

    Current status, such as draft, scheduled, sending, or sent.

  • Name
    data[].templateobject
    Description

    Template metadata or full template payload depending on broadcast status.

POST/v1/batch/broadcasts

Create Broadcasts

Create new broadcasts to be sent.

Required Attributes

Requires a broadcasts array containing the broadcast object properties.
  • Name
    namestring
    Description

    Name of the broadcast such as a campaign name.

  • Name
    subjectstring
    Description

    Subject line of the broadcast email.

  • Name
    contentstring
    Description

    Broadcast body content. Supports Liquid tags.

  • Name
    typestring
    Description

    The type of email. plain for Bento's CSS or raw to use your own.

  • Name
    fromobject
    Description

    A key/value object for the sender. Must be an author in your account.

  • Name
    inclusive_tagsstring
    Description

    A comma separated list of tags to send to.

  • Name
    exclusive_tagsstring
    Description

    A comma separated list of tags you do not want the email to go to.

  • Name
    segment_idstring
    Description

    The segment ID for the campaign.

  • Name
    batch_size_per_hourinteger
    Description

    The number of emails to send per hour to ensure the highest delivery.

  • Name
    inbox_snippetstring
    Description

    Preview text shown after the subject line in supporting inboxes. You can also send this value as preview_text, preview, preheader, preheader_text, or preview_snippet.

  • Name
    send_atdatetime
    Description

    The date and time to send the broadcast at.

    Recommended format: 2024-04-23T18:30:00Z
    Required when approved is true
  • Name
    approvedboolean
    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 number of broadcasts created, the created broadcast records, and any item-level failures.

Use broadcasts[].dashboard_url to send someone straight to the draft in Bento.

  • Name
    resultsinteger
    Description

    Number of broadcasts created.

  • Name
    broadcastsarray
    Description

    Broadcasts created by the request.

  • Name
    broadcasts[].idinteger
    Description

    Numeric broadcast ID.

  • Name
    broadcasts[].template_idinteger
    Description

    Numeric template ID for the broadcast content.

  • Name
    broadcasts[].namestring
    Description

    Broadcast name.

  • Name
    broadcasts[].dashboard_urlstring
    Description

    Bento dashboard URL for editing the created broadcast.

  • Name
    failedinteger
    Description

    Number of broadcasts that failed validation or processing.

  • Name
    failuresarray
    Description

    Item-level failure details. Each failure includes the request index, broadcast name, and error.



Content format examples

Use type to decide the format of content.

type: raw example: Product launch announcement

Use a complete email HTML document with inline styles. This gives you full control over layout and rendering.

Code

type: plain example: Weekly newsletter

Use simple markup for standard newsletters. Keep it lightweight with paragraphs, lists, and CTA links styled like buttons.

Code

For raw, include full HTML and inline CSS. For plain, use lightweight content blocks.