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

send_message_request = Helo::SendMessageRequest.new(
  from: Helo::MailAddress1.new(email: "test-email", name: "test-name"),
  to: [],
  cc: [],
  bcc: [],
  reply_to: [],
  subject: "test-subject",
  html: "test-html",
  text: "test-text",
  template: {},
  tracking: {},
  attachments: [],
  tags: ["example1", "example2"],
  headers: {},
  metadata: {}
)
Helo::Sending.broadcast_message(send_message_request)
{
  "status": "<string>",
  "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suppressions": [
    "<string>"
  ]
}

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
to
object[]
required
cc
object[]
bcc
object[]
replyTo
object[]
subject
string
html
string
text
string
template
object
tracking
object
attachments
object[]
tags
string[]
headers
object
metadata
object

Response

OK

status
string
messageId
string<uuid>
suppressions
string[]