setEmailSenderDomain

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

Registers the domain the organization sends document email from, replacing any earlier one, and returns the DNS records to publish. The domain stays pending until verifyEmailSenderDomain sees the records. Public mailbox domains and the platform's own domain are refused. 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 SetEmailSenderDomain($input: SetEmailSenderDomainInput!) {
  setEmailSenderDomain(input: $input) {
    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 SetEmailSenderDomain($input: SetEmailSenderDomainInput!) {\n  setEmailSenderDomain(input: $input) {\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}",
  "variables": {
    "input": {
      "domain": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "domain": "string"
  }
}

Response:

{
  "data": {
    "setEmailSenderDomain": {
      "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
        }
      ]
    }
  }
}

setEmailSenderDomain(
  input: SetEmailSenderDomainInput!
): EmailSenderDomain!

Arguments

setEmailSenderDomain.input ● SetEmailSenderDomainInput! non-null input

The domain. A bare domain, an address or a web address are all accepted.

Type

EmailSenderDomain object

A domain the organization sends mail from.