Get a mailbox domain - Sendmux

Get a mailbox domain

curl --request GET \
  --url https://app.sendmux.ai/api/v1/domains/{public_id} \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "domain": "mail.acme.com",
    "ses_dkim_status": "<string>",
    "verified_at": "<string>",
    "created_at": "<string>",
    "mailbox_count": 14,
    "dns_records": {
      "mx": [
        {
          "priority": 10,
          "target": "mail.sendmux.ai"
        }
      ],
      "spf": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "dmarc": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "dkim": [
        {
          "name": "_sendmux.acme.com",
          "value": "sendmux-verify=team_abc123"
        }
      ],
      "verification": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      }
    }
  }
}

GET

/

domains

/

{public_id}

Get a mailbox domain

curl --request GET \
  --url https://app.sendmux.ai/api/v1/domains/{public_id} \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "domain": "mail.acme.com",
    "ses_dkim_status": "<string>",
    "verified_at": "<string>",
    "created_at": "<string>",
    "mailbox_count": 14,
    "dns_records": {
      "mx": [
        {
          "priority": 10,
          "target": "mail.sendmux.ai"
        }
      ],
      "spf": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "dmarc": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "dkim": [
        {
          "name": "_sendmux.acme.com",
          "value": "sendmux-verify=team_abc123"
        }
      ],
      "verification": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match

string

Weak ETag from a previous response. Returns 304 when unchanged.

Path Parameters

public_id

string

required

Domain public ID

Example:

"mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

Domain

ok

enum<boolean>

required

Available options:

true

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data

object

required

Hide child attributes

data.id

string

required

Public ID

Example:

"mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data.domain

string

required

Fully qualified domain name

Example:

"mail.acme.com"

data.verification_status

enum<string>

required

Current verification state

Available options:

pending,

verified,

failed

data.ses_dkim_status

string | null

required

SES DKIM status (pending/success/failed/temporary_failure/not_started)

data.verified_at

string | null

required

ISO 8601 timestamp of last successful verification

data.created_at

string

required

ISO 8601 creation timestamp

data.mailbox_count

integer

required

Active mailboxes currently using this domain

Required range: x >= 0

Example:

14

data.dns_records

object

required

Hide child attributes

data.dns_records.mx

object[]

required

MX records the customer must place. All point at Sendmux's inbound mail servers.

Hide child attributes

data.dns_records.mx.priority

integer

required

Example:

10

data.dns_records.mx.target

string

required

Example:

"mail.sendmux.ai"

data.dns_records.spf

object

required

SPF TXT record covering both SES and Sendmux includes

Hide child attributes

data.dns_records.spf.name

string

required

Example:

"_sendmux.acme.com"

data.dns_records.spf.value

string

required

Example:

"sendmux-verify=team_abc123"

data.dns_records.dmarc

object

required

DMARC enforcement record (quarantine, no reporting)

Hide child attributes

data.dns_records.dmarc.name

string

required

Example:

"_sendmux.acme.com"

data.dns_records.dmarc.value

string

required

Example:

"sendmux-verify=team_abc123"

data.dns_records.dkim

object[]

required

Three SES DKIM CNAME records

Hide child attributes

data.dns_records.dkim.name

string

required

Example:

"_sendmux.acme.com"

data.dns_records.dkim.value

string

required

Example:

"sendmux-verify=team_abc123"

data.dns_records.verification

object

required

Ownership-proof TXT record (Sendmux-specific)

Hide child attributes

data.dns_records.verification.name

string

required

Example:

"_sendmux.acme.com"

data.dns_records.verification.value

string

required

Example:

"sendmux-verify=team_abc123"

Add a mailbox domain

Download a domain as a zone file