lumail.domains.create

SDK 2.1.0 · API v2 · POST /api/v2/domains

MethodPOST

/api/v2/domains

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.domains.create({
  domain: "mail.example.com",
});
if (error) {
  throw error;
}
console.log(data.id, data.dnsRecords);

Response Examples

{
  "id": "dom_abc123",
  "domain": "mail.example.com",
  "status": "PENDING",
  "dnsRecords": [
    { "type": "CNAME", "name": "abc._domainkey.mail.example.com", "value": "abc.dkim.amazonses.com" }
  ]
}

[email protected] · lumail.domains

domains.create({ domain: string }): Promise<LumailResult<DomainRecord>>

Registers the domain and returns DNS records.

Body Parameters

Name	Type	Description
`domain`	string	Required. Hostname to register as a sending domain.

Response Fields

Field	Type	Description
`id`	string	Domain id.
`domain`	string	Hostname.
`status`	string	Usually `PENDING` until DNS verifies.
`region`	string	Optional SES region.
`createdAt`	string	Optional ISO 8601 timestamp.
`sesRecords`	unknown	Optional provider DNS payload.
`dnsRecords`	unknown[]	Records to publish at your DNS host.
`message`	string	Optional status note.

data is the domain record. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.domains.list Nextlumail.domains.get