Email

Add a sending domain

Makes one of this project's domains (connected or purchased) a sending domain. When its DNS is hosted here, we add the records ourselves: an existing SPF record is merged (never a second one), an MX record of the user's mailbox is never touched, and nothing is deleted, so the user's mail keeps working. When the user manages DNS elsewhere, records lists what they need to add there (state add_yourself). A DMARC record is only suggested when there is none. Then call verify_email_domain. Adding the same domain again returns the existing one.

post/email-domains

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-domains
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:write)

Request body

domainstring required

A domain of this project (connected with connect_domain or bought with register_domain), like example.com.

Response

Already a sending domain of this project.

idstring uuid required
domainstring required
status'pending' | 'verified' | 'failed' required
testboolean required
dns'managed' | 'manual' required

managed: the domain's DNS is here and we set the records; manual: the user adds them at their own DNS provider.

next_stepstring required
checked_atstring nullable required
verified_atstring nullable required
created_atstring required

Changes

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