NYnylas
Manage Domains

Verify domain

Changed on
<div id="admonition-warning">⚠️ <b>Before you can use the Manage Domains endpoints, you need a <a href="/docs/v3/auth/nylas-service-account/">Nylas Service Account</a></b>.</div>

Triggers a verification check for the specified DNS record type. Before calling this endpoint, add the required DNS records to your domain's DNS configuration. You can get the required records by calling the Get domain info endpoint.

post/v3/admin/domains/{domain_id}/verify

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

type'ownership' | 'mx' | 'spf' | 'dkim' | 'feedback' required

The type of DNS verification to trigger.

Example request

{
  "type": "dkim"
}

Response

OK

request_idstring

ID of the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": {
    "domain_id": "abc-123-domain-id",
    "attempt": {
      "type": "ownership",
      "options": {
        "host": "@",
        "type": "TXT",
        "value": "nylas-ownership-verify=gNIeZAtY1lPUEpWOhA2XBB..."
      }
    },
    "status": "done",
    "created_at": 1742932766,
    "expires_at": 1743537566,
    "message": "Domain ownership verified successfully."
  }
}

Changes