Domains

Add a domain

Adds a domain and answers with the DNS records to publish at its DNS host, and where to publish them (setup). Nothing changes in the domain's DNS or where its email goes today: publishing the MX records later moves its incoming email here. A domain the workspace already has comes back unchanged (200, created: false). A workspace owner's or admin's key; plan limits apply (403 limit_reached), and at most 10 domains an hour can be added through the API.

post/api/v1/domains

Request

  • Base URL: https://supermailos.com
  • URL: https://supermailos.com/api/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

A domain you own, or a subdomain of one (agents.acme.com).

Example request

{
  "domain": "acme.com"
}

Response

The workspace already has it.

createdfalse required

Example response

{
  "domain": {
    "domain": "acme.com"
  }
}

Changes

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