Check automatic Custom Tracking Domain setup eligibility
Reports whether the domain's DNS provider supports Domain Connect for its current Custom Tracking Domain.
GET
Reports whether the domain's DNS provider supports Domain Connect for its current Custom Tracking Domain. Ineligible is a normal result and the exact manual CNAME records remain available.
apiKeyheader
x-api-key<token>id*stringMatch
^dom_[0-9a-hjkmnp-tv-z]{16,24}$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.getCustomTrackingDomainConnect({
"id": "example"
});Example Response
{
"eligible": false,
"reason": "no-record"
}