Skip to main content
POST
/
admin
/
mailgun-domain
Create Mailgun Domain
curl --request POST \
  --url https://api.decodahealth.com/admin/mailgun-domain \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "domainName": "<string>"
}
'
{
  "id": "<string>",
  "tenantSubDomain": "<string>",
  "domainName": "<string>",
  "state": "UNVERIFIED",
  "isSendingVerified": true,
  "isReceivingVerified": true,
  "createdDate": "2023-11-07T05:31:56Z",
  "smtpLogin": "<string>",
  "dnsRecords": {
    "sendingDnsRecords": [
      {
        "recordType": "<string>",
        "name": "<string>",
        "value": "<string>",
        "valid": "valid",
        "priority": "<string>"
      }
    ],
    "receivingDnsRecords": [
      {
        "recordType": "<string>",
        "name": "<string>",
        "value": "<string>",
        "valid": "valid",
        "priority": "<string>"
      }
    ],
    "dmarcDnsRecords": [
      {
        "recordType": "<string>",
        "name": "<string>",
        "value": "<string>",
        "valid": "valid",
        "priority": "<string>"
      }
    ]
  },
  "updatedDate": "2023-11-07T05:31:56Z",
  "verifiedDate": "2023-11-07T05:31:56Z"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Request body for creating a new Mailgun domain.

domainName
string
required

The domain name to register (e.g., mail.example.com)

Response

Successful Response

Full details of a Mailgun domain.

id
string
required
tenantSubDomain
string
required
domainName
string
required
state
enum<string>
required
Available options:
UNVERIFIED,
ACTIVE,
DISABLED
isSendingVerified
boolean
required
isReceivingVerified
boolean
required
createdDate
string<date-time>
required
smtpLogin
string | null
dnsRecords
MailgunDNSRecords · object

DNS records grouped by purpose.

updatedDate
string<date-time> | null
verifiedDate
string<date-time> | null