API reference / Email
Verify the email domain
Checks the DNS records of the workspace's email domain now. Troopy also checks a domain that waits every 5 minutes, for 3 days. Owners and admins only.
/api/v1/email/domain/verifyOther ways to call it
troopy email-domain verifytroopy_verify_email_domainResponse
200 · application/jsondata*object10 properties
domain*stringLike agents.acme.com
status*enum<string>pending waits for its DNS records. verified: teammates send and get mail on it. failed: error says why
pendingverifiedfailed
error*string | nullWhy it failed, or what still waits
records*array<object>The records to add at the DNS host of the domain
7 properties
type*enum<string>CNAMEMXTXT
name*stringThe full name of the record
value*stringpriority*integer | nullFor an MX record
purpose*enum<string>dkiminboundmail_fromdmarc
ok*booleanWhat the latest check found
optional*booleanIt helps mail land, but the domain verifies without it
zone*string | nullThe DNS zone that holds the records. A DNS host asks for the name of a record without it
dnsHost*string | nullWho serves the zone, like Namecheap, when Troopy knows its name servers
zoneMail*array<object>The MX records of the zone when the domain is a subdomain: the business's own mail. Keep them
2 properties
priority*integerhost*stringcheckedAt*string | nullverifiedAt*string | nullcreatedAt*stringISO 8601 date and time