Verify domain - Manage Domains - API Reference

POST

https://api.us.nylas.com/v3/domains/{domain_id}/verify

Checks the DNS record for one verification type.

The response is 200 whether or not the record is verified, so check status. If it's failed, wait a few minutes and try again. SPF, DKIM, and feedback records can take a few minutes to verify.

Requires an IAM API key with the domains.update permission. Application API keys and access tokens don't work.

Parameters

Path parameters

domain_id*string

The domain's ID or address.

Example: "0a2171c6-c298-4671-8b82-d832a7fd5170"

Request body

type*string

The verification type. Nylas doesn't check dmarc or arc records.

ownershipmxspfdkimfeedbackdmarcarc

Example: "ownership"

optionsobject

Options for the verification type. Only dkim uses options.

Responses

request_idstring

ID of the request.

Example: "5fa64c92-e840-4357-86b9-2aa364d35b88"

dataobject

curl --request POST \ --url "https://api.us.nylas.com/v3/domains/${DOMAIN_ID}/verify" \ --header "Authorization: Bearer $NYLAS_DOMAINS_KEY" \ --header "Content-Type: application/json" \ --data '{ "type": "ownership" }'