Send with API

You’re ready for your first send!Send via API using an HTTP client or use one of the Helo SDKs.

While your account is in test mode, you can only send to email addresses on domains you have verified in step #1. Select the recipient for your first test send accordingly.

curl --location "https://api.helohq.com/send/transactional" \
--header "X-Helo-Channel-Id: $HELO_CHANNEL_ID" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer $HELO_API_KEY" \
--data @- <<EOF
{
  "from": {
    "email": "$FROM_ADDRESS",
    "name": "From Name"
  },
  "to": [
    {
      "email": "recipient@example.com",
      "name": "Recipient Name"
    }
  ],
  "subject": "Hello from Helo",
  "html": "<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
  "text": "This is a test message, delivered with <3 by Helo."
}
EOF

using Helo.ApiClient;
using Helo.ApiClient.Errors;
using Helo.ApiClient.Sending;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var apiKey = Environment.GetEnvironmentVariable("HELO_API_KEY")
             ?? throw new Exception("Invalid HELO_API_KEY");
var channelId = Environment.GetEnvironmentVariable("HELO_CHANNEL_ID")
                ?? throw new Exception("Invalid HELO_CHANNEL_ID");
var fromAddress = Environment.GetEnvironmentVariable("FROM_ADDRESS")
                  ?? throw new Exception("Invalid FROM_ADDRESS");

var builder = Host.CreateApplicationBuilder(args);
builder.Services.AddHelo(apiKey);

var host = builder.Build();

using var scope = host.Services.CreateScope();

var client = scope.ServiceProvider.GetRequiredService<IHeloApiClient>();

try
{
    await client.Sending.Transactional(new SendMessageRequest
    {
        From = new MailAddress { Email = fromAddress, Name = "From Name" },
        To = [new MailAddress { Email = "recipient@example.com", Name = "Recipient Name" }],
        Subject = "Hello from Helo",
        Html = "<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
        Text = "This is a test message, delivered with <3 by Helo.",
    }, channelId);
}
catch (ApiErrorException ex)
{
    Console.WriteLine(ex.ErrorResponse.Detail);
}

import Helo from "@helo-email/sdk";

const apiKey = process.env.HELO_API_KEY;
const channelId = process.env.HELO_CHANNEL_ID;
const fromAddress = process.env.FROM_ADDRESS;

const client = new Helo(apiKey);

await client.sending.transactional(
  {
    from: {
      email: fromAddress,
      name: "From Name",
    },
    to: [
      {
        email: "recipient@example.com",
        name: "Recipient Name",
      },
    ],
    subject: "Hello from Helo",
    html: "<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
    text: "This is a test message, delivered with <3 by Helo.",
  },
  { channelId },
);

import sdk_helo_email
import os

api_key = os.getenv('HELO_API_KEY')
channel_id = os.getenv('HELO_CHANNEL_ID')
from_address = os.getenv('FROM_ADDRESS')

client = sdk_helo_email.Helo(api_key=api_key)

response = client.sending.transactional(
    from_={"email": from_address, "name": "From Name"},
    to=[{"email": "recipient@example.com", "name": "Recipient Name"}],
    subject="Hello from Helo",
    html="<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
    text="This is a test message, delivered with <3 by Helo.",
    channel_id=channel_id
)
print(response.message_id)

require "helo"

Helo.configure do |config|
  config.api_key = ENV.fetch("HELO_API_KEY")
end

channel_id = ENV.fetch("HELO_CHANNEL_ID")
from_address = ENV.fetch("FROM_ADDRESS")

request = Helo::SendMessageRequest.new(
  from: Helo::MailAddress.new(email: from_address, name: "From Name"),
  to: [Helo::MailAddress.new(email: "recipient@example.com", name: "Recipient Name")],
  subject: "Hello from Helo",
  html: "<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
  text: "This is a test message, delivered with <3 by Helo."
)

response = Helo::Sending.transactional(
  request,
  channel_id: channel_id
)

puts response.message_id

package main

import (
	"context"
	"log"
	"os"

	"github.com/helo-email/helo-sdk-go"
)

func main() {
	client := helo.NewHelo(os.Getenv("HELO_API_KEY"))
	channelId := os.Getenv("HELO_CHANNEL_ID")
	fromAddress := os.Getenv("FROM_ADDRESS")

	params := &helo.SendMessageRequest{
		From:    helo.MailAddress{Email: fromAddress, Name: "From Name"},
		To:      []helo.MailAddress{{Email: "recipient@example.com", Name: "Recipient Name"}},
		Subject: "Hello from Helo",
		Html:    "<html><body><h1>Hi there, new friend.</h1><p>This is a test message, delivered with <3 by Helo. </p></body></html>",
		Text:    "This is a test message, delivered with <3 by Helo.",
	}
	opts := &helo.SendingTransactionalOptions{
		ChannelID: channelId,
	}

	ctx := context.Background()

	result, err := client.Sending.Transactional(ctx, params, opts)
	if err != nil {
		log.Fatal(err)
		return
	}

	log.Printf("%s", result.MessageID)
}

Getting started

Core concepts

Platforms

Set up your sending domain

Create your first Channel

Create your API credentials

Send your first email

Need help sending your first email?

Contact us

Next steps

Sending transactional

Sending broadcasts

Domains

Channels

Activity

Suppressions

Webhooks

Set up your sending domain

Create your first Channel

Create your API credentials

Send your first email

​Need help sending your first email?

Contact us

​Next steps

Sending transactional

Sending broadcasts

Domains

Channels

Activity

Suppressions

Webhooks

Need help sending your first email?

Next steps