Email Domains

Create a new email domain

post/email-domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/email-domains
  • Auth: HTTP bearer

Request body

domainstring required

Domain name (e.g., "updates.example.com")

provider_idinteger required

Provider ID to use for this domain

Example request

{
  "domain": "updates.example.com"
}

Response

Domain created successfully

Example response

{
  "dns_records": [
    {
      "name": "temps._domainkey.example.com",
      "record_type": "TXT",
      "value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3..."
    }
  ],
  "domain": {
    "created_at": "2025-12-03T10:30:00Z",
    "domain": "updates.example.com",
    "status": "verified",
    "updated_at": "2025-12-03T10:30:00Z"
  }
}

Changes

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