Domains

Add a sending domain

post/domains

Request

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

Request body

namestring required
inbound_enabledboolean

Request inbound receiving for the domain as soon as verification succeeds.

inboundEnabledboolean

Alias for inbound_enabled.

tenantstring

Give the new domain to this tenant (its external_id or id). Only that tenant can send from it. A key limited to one tenant always adds domains to its tenant.

Example request

{
  "name": "example.com"
}

Response

Domain created with DNS records to add

inbound_notestring required
mail_server_dns_syncedboolean

Whether mail-server DKIM/return-path records were synced into the response records

mail_server_dns_errorstring

Present when mail-server DNS sync failed; ownership/SPF/DMARC records are still returned

Example response

{
  "domain": {
    "name": "example.com"
  },
  "records": [
    {
      "type": "TXT"
    }
  ],
  "inbound_records": [
    {
      "type": "TXT"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.