Check one-click DNS eligibility
Reports whether the domain's DNS provider supports Domain Connect one-click setup for Samva, and the provider's name when it does.
GET
Reports whether the domain's DNS provider supports Domain Connect one-click setup for Samva, and the provider's name when it does. Ineligible is a normal result — the manual DNS records remain the way to verify.
apiKeyheader
x-api-key<token>id*stringMatch
^dom_[0-9a-hjkmnp-tv-z]{16,24}$mode*stringValue in
"send-only""send-and-receive"DomainConnectEligibility
application/json- response
eligible*falseValue in
falsereason*stringValue in
"no-record""no-settings""no-sync""no-template""unavailable"import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.email.getDomainConnect({
"id": "example",
"mode": "send-only"
});Example Response
{
"eligible": false,
"reason": "no-record"
}