Domains
Add a sending domain
Add a new sending domain to a tenant. Returns DNS records that must be configured before the domain can be verified.
Each tenant gets their own isolated mail server for domain isolation.
Required DNS records:
- SPF - TXT record for sender authentication
- DKIM - TXT record for email signing
- Return Path - CNAME for bounce handling
After adding DNS records, call POST /tenants/{tenantId}/domains/{domainId}/verify to verify.
post/tenants/{tenantId}/domains
Path parameters
tenantIdstring required
The tenant ID
Request body
Example request
{
"name": "mail.mycompany.com"
}Response
Domain added
Example response
{
"data": {
"id": 123,
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "example.com",
"verified": true,
"verifiedAt": "2024-01-15T10:30:00Z",
"dnsRecords": {
"zone": "example.com",
"spf": {
"type": "TXT",
"name": "ark-xyz._domainkey",
"fullName": "ark-xyz._domainkey.example.com",
"value": "v=spf1 include:spf.arkhq.io ~all",
"status": "OK"
},
"dkim": {
"type": "TXT",
"name": "ark-xyz._domainkey",
"fullName": "ark-xyz._domainkey.example.com",
"value": "v=spf1 include:spf.arkhq.io ~all",
"status": "OK"
},
"returnPath": {
"type": "TXT",
"name": "ark-xyz._domainkey",
"fullName": "ark-xyz._domainkey.example.com",
"value": "v=spf1 include:spf.arkhq.io ~all",
"status": "OK"
}
},
"createdAt": "2024-01-10T08:00:00Z",
"tenant_id": "cm6abc123def456",
"tenant_name": "Acme Corp"
},
"meta": {
"requestId": "req_V1StGXR8_Z5jdHi6"
}
}