Email domains

Get dns setup

Returns the DKIM CNAME records that have to exist on the customer's domain, each with its current status, for the email domain with the given name. Despite reading like a lookup this drives the verification: it performs live DNS lookups, moves the domain through its verification phases (creating the Deskhero side DNS records, then creating and verifying the sending identity), stores the new status, and emails the User who added the domain once it becomes verified.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/email_domains/get_dns_setup/{domain}

Authorisation: Minimum role: ADMIN

Request arguments

Name	Type	Source
domain	String

Request body example

Response

Status: 200 (OK)
Type: DTO_dns_setup[]

Wrapper: DTO_response_wrap

Other statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

DTO_dns_setup

Name	Type	Description
type	ENUM dns_record_type	Leave empty on input
status	ENUM dns_setup_status	Status
host_value	String	Host value
data	String	Data

ENUM dns_record_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	TXT	TXT
2	CNAME	CNAME

ENUM dns_setup_status

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	PENDING	Waiting client to setup DNS records (or verification of it)
2	INSTALLING	Client DNS record setup completed, and verification done
3	COMPLETED	Install completed

Generated Aug 4, 2026 18:37