Turn inbound receiving on or off

Enable or disable inbound email for a verified domain (paid plans). Returns the MX record to publish and the receiving status: disabled, pending, active or failed. Requires the domain:write scope.

patch/v1/domains/{id}

Request

Base URL: https://smtpfa.st/api
URL: https://smtpfa.st/api/v1/domains/{id}
Auth: HTTP bearer

Path parameters

idstring required

The domain ID (e.g. dom_xyz789)

Request body

receiving_enabledboolean required

Response

Receiving settings

idstring

Example response

{
  "receiving": {
    "mx_record": {
      "type": "MX",
      "priority": 10
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.