/domains

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

region?string

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.

Value in

"us-east-1"
"eu-west-1"
"sa-east-1"
"ap-northeast-1"

custom_return_path?string

Default"send"

open_tracking?boolean

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

click_tracking?boolean

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

tracking_subdomain?string

DNS label of the branded tracking host, e.g. "links" for links.. 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 Body

`application/json`

curl -X POST "https://example.com/domains" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "status": "string",  "created_at": "string",  "region": "string",  "open_tracking": true,  "click_tracking": true,  "tracking_subdomain": "string",  "capabilities": {    "sending": "string",    "receiving": "string"  },  "records": [    {      "record": "string",      "name": "string",      "type": "string",      "ttl": "string",      "status": "string",      "value": "string",      "priority": 0,      "live": "found",      "detail": "string",      "inherited_from": "string",      "policy": "none"    }  ]}

/domains

Request Body

Response Body

200application/json

403application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`