Skip to content

Convert a domain between receiving and send-only

PATCH
/v1/domains/{id}

Switch an existing domain between email (receives, publishes an MX) and email-send (sends only, never receives) without re-adding it. Only that pair converts — a webhook domain publishes a CNAME, which cannot coexist with an MX (RFC 1034/2181), so it is refused with 422.

Converting to email-send is refused with 409 while any alias still receives on the domain: those addresses would keep looking live while receiving nothing. Delete them first. Converting to email publishes an MX, which redirects the domain's mail, so the same acknowledge_mx_conflict gate as create applies — and the domain returns to pending-dns until that MX resolves.

Ownership TXT, DKIM CNAMEs and any MAIL FROM records are untouched either way, so nothing already published needs republishing, and a domain already enabled for sending keeps sending across the conversion.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
string
Required

Request Body

application/json
JSON
{
  
"kind": "string",
  
"acknowledge_mx_conflict": true
}

Responses

The converted domain and the record set to publish.

application/json
JSON
{
  
"id": "dom_01JX9",
  
"domain": "notify.acme.com",
  
"kind": "string",
  
"state": "string",
  
"records": [
  
  
{
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product