Ruby
Helo.configure do |config|
config.api_key = ENV.fetch("HELO_API_KEY")
end
create_domain_request = Helo::CreateDomainRequest.new(
name: "test-name",
channel_ids: ["550e8400-e29b-41d4-a716-446655440000", "6ba7b810-9dad-11d1-80b4-00c04fd430c8"]
)
Helo::Domains.create(create_domain_request)import Helo from "@helo-email/sdk";
const apiKey = process.env.HELO_API_KEY;
const helo = new Helo(apiKey);
const result = await helo.domains.create({
name: "test-name",
channelIds: ["550e8400-e29b-41d4-a716-446655440000"],
});package main
import (
"context"
"log"
"os"
"github.com/helo-email/helo-sdk-go"
)
func main() {
client := helo.NewHelo(os.Getenv("HELO_API_KEY"))
ctx := context.Background()
params := &helo.CreateDomainRequest{
Name: "test-name",
ChannelIds: []string{"550e8400-e29b-41d4-a716-446655440000"},
}
result, err := client.Domains.Create(ctx, params)
if err != nil {
log.Fatal(err)
}
_ = result
}using HeloEmail.Sdk.Domains;
var domain = await helo.Domains.Create(new CreateDomainRequest
{
Name = "mail.example.com",
ChannelIds = ["channel-id"],
});import sdk_helo_email as helo
client = helo.Helo() # reads HELO_API_KEY from the environment
domain = client.domains.create(name="mail.example.com", channel_ids=["channel-id"]){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"verified": true,
"dnsRecords": {
"domainKeyActive": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"domainKeyPending": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"returnPath": [
{
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
}
],
"tracking": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"unsubscribe": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
}
},
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"deleted": true
}
]
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}Domains
Create a domain
Registers a new domain for sending emails. The domain must be verified before it can be used.
POST
/
domains
Ruby
Helo.configure do |config|
config.api_key = ENV.fetch("HELO_API_KEY")
end
create_domain_request = Helo::CreateDomainRequest.new(
name: "test-name",
channel_ids: ["550e8400-e29b-41d4-a716-446655440000", "6ba7b810-9dad-11d1-80b4-00c04fd430c8"]
)
Helo::Domains.create(create_domain_request)import Helo from "@helo-email/sdk";
const apiKey = process.env.HELO_API_KEY;
const helo = new Helo(apiKey);
const result = await helo.domains.create({
name: "test-name",
channelIds: ["550e8400-e29b-41d4-a716-446655440000"],
});package main
import (
"context"
"log"
"os"
"github.com/helo-email/helo-sdk-go"
)
func main() {
client := helo.NewHelo(os.Getenv("HELO_API_KEY"))
ctx := context.Background()
params := &helo.CreateDomainRequest{
Name: "test-name",
ChannelIds: []string{"550e8400-e29b-41d4-a716-446655440000"},
}
result, err := client.Domains.Create(ctx, params)
if err != nil {
log.Fatal(err)
}
_ = result
}using HeloEmail.Sdk.Domains;
var domain = await helo.Domains.Create(new CreateDomainRequest
{
Name = "mail.example.com",
ChannelIds = ["channel-id"],
});import sdk_helo_email as helo
client = helo.Helo() # reads HELO_API_KEY from the environment
domain = client.domains.create(name="mail.example.com", channel_ids=["channel-id"]){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"verified": true,
"dnsRecords": {
"domainKeyActive": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"domainKeyPending": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"returnPath": [
{
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
}
],
"tracking": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"unsubscribe": {
"host": "<string>",
"value": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
}
},
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"deleted": true
}
]
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"instance": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"requestId": "<string>",
"errors": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
⌘I