Update Domain

Update an existing domain.

Path Parameters

The Domain ID.

Body Parameters

Track clicks within the body of each HTML email.

Track the open rate of each email.

Configure a custom subdomain for click and open tracking. For example, setting "links" on domain example.com will produce a CNAME record for links.example.com. Avoid setting values that have a negative connotation (e.g. tracking).

This value can only be changed after it has been specified, never removed. This is to preserve any email links that may already be sent with the current tracking subdomain.

After changing the tracking subdomain, a new DNS record must be verified, until then, the previous value is used. Do not remove old tracking DNS records, all previously used records remain active and are included in the response.

Learn more about custom tracking subdomains.

tls (string)
- opportunistic: Opportunistic TLS means that it always attempts to make a secure connection to the receiving mail server. If it can't establish a secure connection, it sends the message unencrypted.
- enforced: Enforced TLS on the other hand, requires that the email communication must use TLS no matter what. If the receiving server does not support TLS, the email will not be sent.
capabilities (object) — Update the domain capabilities for sending and receiving emails. You can specify one or both fields. Omitted fields will keep their current value. At least one capability must remain enabled.
properties
- sending (string) — Enable or disable sending emails from this domain. Possible values: 'enabled' | 'disabled'
- receiving (string) — Enable or disable receiving emails to this domain. Possible values: 'enabled' | 'disabled'

Node.js

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.domains.update({
  id: 'b8617ad3-b712-41d9-81a0-f7c3d879314e',
  openTracking: false,
  clickTracking: true,
  trackingSubdomain: 'links',
  tls: 'enforced',
});

PHP

$resend = Resend::client('re_xxxxxxxxx');

$resend->domains->update(
  'b8617ad3-b712-41d9-81a0-f7c3d879314e',
  [
    'open_tracking' => false,
    'click_tracking' => true,
    'tracking_subdomain' => 'links',
    'tls' => 'enforced',
  ]
);

Python

import resend

resend.api_key = "re_xxxxxxxxx"

params: resend.Domains.UpdateParams = {
  "id": "b8617ad3-b712-41d9-81a0-f7c3d879314e",
  "open_tracking": False,
  "click_tracking": True,
  "tracking_subdomain": "links",
  "tls": "enforced",
}

resend.Domains.update(params)

Ruby

require "resend"

Resend.api_key = "re_xxxxxxxxx"

Resend::Domains.update({
  id: "b8617ad3-b712-41d9-81a0-f7c3d879314e",
  open_tracking: false,
  click_tracking: true,
  tracking_subdomain: "links",
  tls: "enforced",
})

package main

import "github.com/resend/resend-go/v4"

func main() {
	client := resend.NewClient("re_xxxxxxxxx")

	updateDomainParams := &resend.UpdateDomainRequest{
		OpenTracking:      false,
		ClickTracking:     true,
		TrackingSubdomain: "links",
		Tls:               resend.Enforced,
	}

	client.Domains.Update("b8617ad3-b712-41d9-81a0-f7c3d879314e", updateDomainParams)
}

Rust

use resend_rs::{types::{DomainChanges, Tls}, Resend, Result};

#[tokio::main]
async fn main() -> Result<()> {
  let resend = Resend::new("re_xxxxxxxxx");

  let changes = DomainChanges::new()
    .with_open_tracking(false)
    .with_click_tracking(true)
    .with_tracking_subdomain("links")
    .with_tls(Tls::Enforced);

  let _domain = resend
    .domains
    .update("b8617ad3-b712-41d9-81a0-f7c3d879314e", changes)
    .await?;

  Ok(())
}

Java

import com.resend.Resend;
import com.resend.services.domains.model.Tls;
import com.resend.services.domains.model.UpdateDomainOptions;

Resend resend = new Resend("re_xxxxxxxxx");

UpdateDomainOptions params = UpdateDomainOptions.builder()
                .id("b8617ad3-b712-41d9-81a0-f7c3d879314e")
                .openTracking(false)
                .clickTracking(true)
                .trackingSubdomain("links")
                .tls(Tls.ENFORCED)
                .build();

resend.domains().update(params);

.NET

using Resend;

IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI

await resend.DomainUpdateAsync(
    new Guid( "b8617ad3-b712-41d9-81a0-f7c3d879314e" ),
    new DomainUpdateData()
    {
        TrackOpen = false,
        TrackClicks = true,
        TrackingSubdomain = "links",
        TlsMode = TlsMode.Enforced,
    }
);

cURL

curl -X PATCH 'https://api.resend.com/domains/b8617ad3-b712-41d9-81a0-f7c3d879314e' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "open_tracking": false,
  "click_tracking": true,
  "tracking_subdomain": "links",
  "tls": "enforced"
}'

CLI

resend domains update b8617ad3-b712-41d9-81a0-f7c3d879314e \
  --no-open-tracking \
  --click-tracking \
  --tracking-subdomain links \
  --tls enforced

Response

{
  "object": "domain",
  "id": "b8617ad3-b712-41d9-81a0-f7c3d879314e"
}