Domains

Add a domain

Adds a sending domain and returns the DNS records to publish.

post/domains

Request

  • Base URL: https://api.mepmail.dev
  • URL: https://api.mepmail.dev/domains
  • Auth: HTTP bearer

Request body

namestring required
region'us-east-1'

SES region of the identity, one of the regions this deployment serves (the values listed here; the first is the default). Any other region is rejected with 422. A domain has one region: to move it, delete and re-add it.

custom_return_pathstring
open_trackingboolean

Inject a tracking pixel served from the tracking subdomain and record email.opened events. Off by default.

click_trackingboolean

Rewrite links to redirect through the tracking subdomain and record email.clicked events. Off by default.

tracking_subdomainstring

DNS label of the branded tracking host, e.g. "links" for links.<domain>. Setting it adds a Tracking CNAME to records[]; links are tracked through it once that CNAME resolves. Required on MepMail Cloud to turn tracking on.

Response

Domain created

idstring uuid required
namestring required
statusstring required
created_atstring required
regionstring required
open_trackingboolean required
click_trackingboolean required
tracking_subdomainstring nullable required

Changes

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