Create Domain

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.status);

Response Examples

{
  "id": "dom_abc123",
  "domain": "mail.example.com",
  "status": "NOT_STARTED",
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "mail._domainkey.mail.example.com",
      "value": "p=...",
      "purpose": "dkim"
    }
  ],
  "message": "Domain created. Add the DNS records to your DNS provider, then call verify_domain to check verification."
}

Registers a sending domain and returns DNS records. Permission: domains.

Body Parameters

Name	Type	Description
`domain`	string	Required. Hostname to register, e.g. `mail.example.com`.

Response Fields

Field	Type	Description
`id`	string	MailDomain id.
`domain`	string	Registered hostname.
`status`	string	`NOT_STARTED`, `PENDING`, `VERIFIED`, or `FAILED`.
`region`	string	AWS region when provisioned.
`dnsRecords`	array	Records to add: `type`, `name`, `value`, `priority`, `ttl`, `purpose`.
`sesRecords`	array	Stored SES DNS records when present.
`message`	string	Next-step copy.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `domains` permission
400	`validation_error`	Already registered, claimed elsewhere, or plan limit

PreviousList Domains NextGet Domain

Body Parameters

Response Fields

Errors

Related