Update an existing domain

PATCH/domains/{domain_id}Update an existing domain

Parameters

domain_idstringpathrequired

The ID of the domain.

Request body

application/json

objectUpdateDomainOptions

capabilitiesobject

Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.

Show child attributes

receivingstring

Enable or disable receiving emails to this domain.

one of "enabled", "disabled"

sendingstring

Enable or disable sending emails from this domain.

one of "enabled", "disabled"

click_trackingboolean

Track clicks within the body of each HTML email.

open_trackingboolean

Track the open rate of each email.

tlsstring

enforced | opportunistic.

default "opportunistic"

tracking_subdomainstring

The subdomain to use for click and open tracking.

Example request

{
  "capabilities": {
    "receiving": "disabled",
    "sending": "disabled"
  },
  "click_tracking": true,
  "open_tracking": true,
  "tls": "opportunistic",
  "tracking_subdomain": "string"
}

Responses

objectUpdateDomainResponseSuccess

idstring

The ID of the updated domain.

objectstring

The object type representing the updated domain.

Example response

{
  "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
  "object": "domain"
}

Examples

domain_idrequiredpath parameter

curl -X PATCH 'https://api.resend.com/domains/string' \
  -H 'Content-Type: application/json' \
  -d '{"capabilities":{"receiving":"disabled","sending":"disabled"},"click_tracking":true,"open_tracking":true,"tls":"opportunistic","tracking_subdomain":"string"}'

const response = await fetch('https://api.resend.com/domains/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"capabilities":{"receiving":"disabled","sending":"disabled"},"click_tracking":true,"open_tracking":true,"tls":"opportunistic","tracking_subdomain":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.resend.com/domains/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"capabilities\":{\"receiving\":\"disabled\",\"sending\":\"disabled\"},\"click_tracking\":true,\"open_tracking\":true,\"tls\":\"opportunistic\",\"tracking_subdomain\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.resend.com/domains/string",
    headers={"Content-Type": "application/json"},
    data='{"capabilities":{"receiving":"disabled","sending":"disabled"},"click_tracking":true,"open_tracking":true,"tls":"opportunistic","tracking_subdomain":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"capabilities":{"receiving":"disabled","sending":"disabled"},"click_tracking":true,"open_tracking":true,"tls":"opportunistic","tracking_subdomain":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.resend.com/domains/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/domains/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"capabilities\":{\"receiving\":\"disabled\",\"sending\":\"disabled\"},\"click_tracking\":true,\"open_tracking\":true,\"tls\":\"opportunistic\",\"tracking_subdomain\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/domains/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"capabilities\":{\"receiving\":\"disabled\",\"sending\":\"disabled\"},\"click_tracking\":true,\"open_tracking\":true,\"tls\":\"opportunistic\",\"tracking_subdomain\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/domains/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"capabilities\":{\"receiving\":\"disabled\",\"sending\":\"disabled\"},\"click_tracking\":true,\"open_tracking\":true,\"tls\":\"opportunistic\",\"tracking_subdomain\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.resend.com/domains/string");
request.Content = new StringContent("{\"capabilities\":{\"receiving\":\"disabled\",\"sending\":\"disabled\"},\"click_tracking\":true,\"open_tracking\":true,\"tls\":\"opportunistic\",\"tracking_subdomain\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
  "object": "domain"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys