Skip to main content
POST
/
domains
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
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)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "verified": true,
  "dnsRecords": {
    "domainKeyActive": {
      "host": "<string>",
      "value": "<string>"
    },
    "domainKeyPending": {
      "host": "<string>",
      "value": "<string>"
    },
    "returnPath": [
      {
        "host": "<string>",
        "value": "<string>"
      }
    ],
    "tracking": {
      "host": "<string>",
      "value": "<string>"
    },
    "unsubscribe": {
      "host": "<string>",
      "value": "<string>"
    }
  },
  "channels": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "deleted": true
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
channelIds
string<uuid>[]

Response

OK

id
string<uuid>
required
createdAt
string<date-time>
required
name
string
required
verified
boolean
required
dnsRecords
object
required
channels
object[]