Update domain receiving

PATCHhttps://api.mailfully.com/v1/domains/{id}

Turn receiving on or off for a domain. The body takes exactly one field, receiving; any other field, or none, is a 422.

Turning receiving on requires a verified domain (409 domain_not_verified) and looks up the domain's current MX records first. If any of them points at another mail provider, the request is refused with 409 mx_conflict and nothing changes: receive on a subdomain such as inbound.<domain> instead, added as a new domain. A failed lookup returns 503 dns_lookup_failed. On success the response includes the receiving MX record to publish at the domain name.

Turning receiving off is always allowed. Repeating the current state is a no-op 200 that runs no checks and no DNS lookup. Requires the send scope.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

The domain id (dom_…).

Body

receivingbooleanrequired

Turn receiving on (true) or off (false).

Response

application/json

The domain with its full DNS record set.