Connect an email domain
Connects a new domain to the email channel. Returns the domain in pending status together with the DNS records (CNAMEs for sending/DKIM, an MX record for receiving) to add before calling POST /email/domains/{id}/verify. Required scope: assistants:write.
Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Body
"mail.your-domain.com"
Response
The connected domain, pending DNS verification.