Skip to main content
POST
/
send
/
broadcast
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
end

send_broadcast_request = Helo::SendBroadcastRequest.new(
  from: Helo::MailAddress1.new(email: "test-email", name: "test-name"),
  reply_to: [],
  template: {},
  tracking: {},
  attachments: [],
  tags: ["example1", "example2"],
  headers: {},
  metadata: {},
  messages: []
)
Helo::Sending.broadcast(send_broadcast_request)
{
  "status": "<string>",
  "broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Helo-Channel-Id
string<uuid>

Used to specify a channel ID for sending when using an account-level API credential.

X-Helo-Idempotency-Key
string

A unique identifier used to prevent duplicate messages being sent when retrying failed requests.

Maximum string length: 256

Body

application/json
from
object
required
template
object
required
messages
object[]
required
replyTo
object[]
tracking
object
attachments
object[]
tags
string[]
headers
object
metadata
object

Response

OK

status
string
broadcastId
string<uuid>