Update an email domain

PATCH

email_domains

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const EmailDomain = await client.emailDomains.update('id', {
  inbound_enabled: true,
});

console.log(EmailDomain.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
email_domain = client.email_domains.update(
    id="id",
    inbound_enabled=True,
)
print(email_domain.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailDomain, err := client.EmailDomains.Update(
		context.TODO(),
		"id",
		telnyx.EmailDomainUpdateParams{
			InboundEnabled: telnyx.Bool(true),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailDomain.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailDomains.EmailDomainUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        EmailDomainUpdateParams params = EmailDomainUpdateParams.builder()
            .inboundEnabled(true)
            .build();
        var response = client.emailDomains().update("id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $email_domain = $client->emailDomains->update(
    'id',
    inbound_enabled: true,
  );

  var_dump($email_domain);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PATCH \
  --url https://api.telnyx.com/v2/email_domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inbound_enabled": true,
  "tracking": {
    "open_tracking": false
  }
}
'

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

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested email domain was not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "domain is invalid",
      "source": {
        "pointer": "/data/attributes/domain"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "500",
      "title": "Internal Server Error",
      "detail": "An unexpected error occurred"
    }
  ]
}

Authorizations

Authorization

string

header

required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

string<uuid>

required

Email domain UUID

Body

application/json

inbound_enabled

boolean

Enable or disable inbound routing for this domain

dmarc_policy

object | null

Update the DMARC policy. The recommended _dmarc TXT record is rebuilt and its verification reset to pending.

Show child attributes

tracking

object

Show child attributes

Response

Email domain updated

data

object

required

Show child attributes

Example:

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

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const EmailDomain = await client.emailDomains.update('id', {
  inbound_enabled: true,
});

console.log(EmailDomain.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
email_domain = client.email_domains.update(
    id="id",
    inbound_enabled=True,
)
print(email_domain.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailDomain, err := client.EmailDomains.Update(
		context.TODO(),
		"id",
		telnyx.EmailDomainUpdateParams{
			InboundEnabled: telnyx.Bool(true),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailDomain.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailDomains.EmailDomainUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        EmailDomainUpdateParams params = EmailDomainUpdateParams.builder()
            .inboundEnabled(true)
            .build();
        var response = client.emailDomains().update("id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $email_domain = $client->emailDomains->update(
    'id',
    inbound_enabled: true,
  );

  var_dump($email_domain);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PATCH \
  --url https://api.telnyx.com/v2/email_domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inbound_enabled": true,
  "tracking": {
    "open_tracking": false
  }
}
'

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

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested email domain was not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "domain is invalid",
      "source": {
        "pointer": "/data/attributes/domain"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "500",
      "title": "Internal Server Error",
      "detail": "An unexpected error occurred"
    }
  ]
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

Update an email domain

Authorizations

Path Parameters

Body

Response