Sign in
Email Domains

Update an email domain

Updates mutable settings for an existing email domain, including inbound delivery and tracking configuration. Shared domains are read-only for non-owner accounts.

patch/email_domains/{id}

Path parameters

idstring uuid required

Email domain UUID

Request body

inbound_enabledboolean

Enable or disable inbound routing for this domain

Response

Email domain updated

Example response

{
  "data": {
    "created_at": "2026-01-01T00:00:00Z",
    "dkim": {
      "active": false,
      "algorithm": null,
      "key_length": null,
      "rotated_at": null,
      "selector": null
    },
    "dmarc_policy": {
      "p": "none",
      "pct": 100,
      "rua": "mailto:dmarc@telnyx.com"
    },
    "dns_records": [],
    "domain": "example.com",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inbound": {
      "catch_all": false,
      "enabled": false,
      "mx_required": false
    },
    "record_type": "email_domain",
    "status": "pending",
    "tracking": {
      "click_tracking": false,
      "open_tracking": false,
      "unsubscribe_tracking": false
    },
    "type": "custom",
    "updated_at": "2026-01-01T00:00:00Z",
    "usable_for_inbound": false,
    "usable_for_sending": false,
    "verification": {
      "dkim": "pending",
      "dmarc": "missing_optional",
      "mx": "not_required",
      "ownership": "pending",
      "spf": "missing_optional"
    },
    "verified_at": null
  }
}

Changes

Changed in 4 of the 61 revisions of this API.432

  • b1bf96d8391e3See the full diff
    • ●

      added the new not_required enum value to the data/verification/ownership response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new not_required enum value to the data/verification/spf response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new shared_inbound enum value to the data/type response property for the response status 200

      response-property-enum-value-added

  • 80833e66e01031See the full diff
    • ▲

      added EmailDMARCPolicy to the dmarc_policy request property allOf list

      request-property-all-of-added

    • ▲

      the dmarc_policy request property type/format changed from string/ to object/

      request-property-type-changed

    • ▲

      the data/dmarc_policy response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ○

      added EmailDMARCPolicy to the data/dmarc_policy response property allOf list for the response status 200

      response-property-all-of-added

  • 6ef0ae248bf71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 224ed0d8a5c31See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog