Partners

Set your default mail server name

Sets or renames your default name (adds one when you have none). Name a host under your own domain (mail.yourcompany.com) and publish an A record from it to Faivelo's mail proxy (the address in status.setup.value), with no other A or AAAA record for the name. The DNS check runs at once; the proxy then issues and renews the certificate on its own. Customers switch to the name only when both dns.verified and certificate.valid are true. Requires partner:write.

put/mail-host

Request

Base URL: https://faivelo.com/api/partner
URL: https://faivelo.com/api/partner/mail-host
Auth: HTTP bearer

Request body

hoststring required

Example request

{
  "host": "mail.yourcompany.com"
}

Response

The host and the check results

successboolean

Example response

{
  "success": true,
  "data": {
    "status": {
      "host": "mail.yourcompany.com",
      "activeHost": "mx.faivelo.com",
      "setup": {
        "name": "mail.yourcompany.com",
        "value": "18.195.1.2"
      },
      "ports": {
        "imapPort": 993,
        "smtpPort": 465
      }
    }
  }
}

Changes

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