lumail.domains.verify

SDK 2.1.0 · API v2 · POST /api/v2/domains/:domain/verify

MethodPOST

/api/v2/domains/:domain/verify

Request Examples

import { Lumail } from "lumail";

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

Response Examples

{
  "id": "dom_abc123",
  "status": "VERIFIED"
}

[email protected] · lumail.domains

domains.verify(domainOrId: string): Promise<LumailResult<VerifyDomainResponse>>

Checks DNS. Id or hostname.

Path Parameters

Name	Type	Description
`domainOrId`	string	Required. MailDomain id or hostname.

Response Fields

Field	Type	Description
`id`	string	Domain id.
`status`	string	Status after the check (`VERIFIED`, `PENDING`, …).
`dnsRecords`	unknown[]	Remaining or current DNS records when still pending.

data is { id, status, dnsRecords? }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.domains.get Nextlumail.campaigns