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

MethodEndpointName
POSTbatch/broadcastsCreate Broadcasts
GETfetch/broadcastsGet Broadcasts

The Broadcast Model

The broadcast model contains a full set of keys that repesent 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.

Request

GET
/v1/fetch/subscribers
curl -L -X GET 'https://app.bentonow.com/api/v1/fetch/broadcasts' \
-H 'Accept: application/json' \
-H 'Authorization: Basic BASE64ENCODE(USERNAME+PASSWORD)'


Response

Returns a collection of broadcasts and their details.

JSON Response

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "name": "string",
        "share_url": "string",
        "template": {
          "subject": "string",
          "to": "string",
          "html": "string"
        },
        "created_at": "2024-08-06T05:44:04.433Z",
        "sent_final_batch_at": "2024-08-06T05:44:04.433Z",
        "send_at": "2024-08-06T05:44:04.433Z",
        "stats": {
          "open_rate": 0
        }
      }
    }
  ]
}

POST/v1/batch/broadcasts

Create Broadcasts

Create new broadcasts to be sent.

Required Attributes

  • 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.

  • Name
    approved
    Type
    boolean
    Description

    Whether the broadcast has been approved by Bento and will be sent at the scheduled time.

Request

POST
/v1/batch/broadcasts
curl -L -X POST 'https://app.bentonow.com/api/v1/batch/broadcasts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic BASE64ENCODE(USERNAME+PASSWORD)' \
--data-raw '{
      "broadcasts": [
        {
          "name": "Campaign #1 — Plain Text Example",
          "subject": "Hello Plain World",
          "content": "<p>Hi {{ visitor.first_name }}</p>",
          "type": "plain",
          "from": {
              "email": "[email protected]",
              "name": "John Doe"
          },
          "inclusive_tags": "lead,mql",
          "exclusive_tags": "customers",
          "segment_id": "segment_123456789",
          "batch_size_per_hour": 1500
        }
      ]
}'


Response

Returns the count of broadcasts queued for processing.

JSON Response

{
  "results": 1000
}

Was this page helpful?