verifyEmailSenderDomain

Requires at least one of the permissions settings:email:update or settings:tenant:update.

Checks the published DNS records of the registered sender domain with the email provider and returns the updated status. Requires permission to update email settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation VerifyEmailSenderDomain {
  verifyEmailSenderDomain {
    id
    status
    domain
    lastCheckedAt
    lastError
    verifiedAt
    dnsRecords {
      type
      host
      purpose
      value
      verified
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation VerifyEmailSenderDomain {\n  verifyEmailSenderDomain {\n    id\n    status\n    domain\n    lastCheckedAt\n    lastError\n    verifiedAt\n    dnsRecords {\n      type\n      host\n      purpose\n      value\n      verified\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "verifyEmailSenderDomain": {
      "id": "string",
      "status": "FAILED",
      "domain": "string",
      "lastCheckedAt": "2025-01-15T00:00:00Z",
      "lastError": "string",
      "verifiedAt": "2025-01-15T00:00:00Z",
      "dnsRecords": [
        {
          "type": "string",
          "host": "string",
          "purpose": "string",
          "value": "string",
          "verified": true
        }
      ]
    }
  }
}

verifyEmailSenderDomain: EmailSenderDomain!

Type

EmailSenderDomain object

A domain the organization sends mail from.