Mail API reference

Mail API · Public

get/v1/public/domain-setup/{token}

Public, read-only DNS setup for a shared domain (no authentication).

What a share link opens: the domain name, every DNS record it needs with its live state, the DKIM signing check, and download links. Nothing about the workspace. States are as of the last check (every 5 minutes while the domain is pending). Answers 404 for an unknown, expired or revoked link. Limited to 60 requests per minute per IP.

Path parameters

token*string

The share token from the link (43 characters, base64url).

Query parameters

zonestring · hostname

Render `name_relative` against this zone (the domain or one of its parents).

Response · 200

fqdn*string

The domain name.

Example: "mail.example.com"

status*object

`active` once the required records verify.

zone*string

Zone the relative names are rendered against.

Example: "example.com"

last_checked_at*string · date-time

When the records were last checked (every 5 minutes while the domain is pending, hourly once active).

expires_at*string · date-time

When this link stops working.

records*array

The records to publish.

ses*object
dkim_status*object

DKIM signing verification of the DKIM record.

mail_from_status*object

Verification of the custom MAIL FROM host.

exports*object
bind*string · uri

BIND zone fragment of the records still to publish.

csv*string · uri

CSV of the records still to publish.

Example

Request

GET https://api.mail.productcraft.co/v1/public/domain-setup/{token}

Response

{
  "fqdn": "mail.example.com",
  "status": {},
  "zone": "example.com",
  "last_checked_at": "2026-01-01T00:00:00.000Z",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "records": [
    {
      "purpose": "dkim",
      "type": "TXT",
      "host": "productcraft._domainkey.mail.example.com",
      "name_relative": "productcraft._domainkey.mail",
      "value": "v=DKIM1; k=rsa; p=MIIBIjANBgkqh…",
      "priority": 10,
      "ttl": 3600,
      "required": true,
      "state": "missing",
      "found": [
        "string"
      ],
      "conflicts": [
        {
          "code": "spf_multiple",
          "severity": {},
          "message": "string",
          "suggested_value": "v=spf1 include:amazonses.com include:_spf.google.com ~all"
        }
      ],
      "hint": "string",
      "covered_by": "_dmarc.example.com",
      "last_checked_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "ses": {
    "dkim_status": {},
    "mail_from_status": {}
  },
  "exports": {
    "bind": "string",
    "csv": "string"
  }
}