curl --request PATCH \
--url https://brew.new/api/v1/domains/{domainId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"defaultSenderName": "Brew",
"defaultFromEmail": "hello"
}
'import requests
url = "https://brew.new/api/v1/domains/{domainId}"
payload = {
"defaultSenderName": "Brew",
"defaultFromEmail": "hello"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({defaultSenderName: 'Brew', defaultFromEmail: 'hello'})
};
fetch('https://brew.new/api/v1/domains/{domainId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/domains/{domainId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'defaultSenderName' => 'Brew',
'defaultFromEmail' => 'hello'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/domains/{domainId}"
payload := strings.NewReader("{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/domains/{domainId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/domains/{domainId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}"
response = http.request(request)
puts response.read_body{
"domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
"domainUrl": "https://send.example.com",
"name": "send.example.com",
"region": "us-east-1",
"status": "pending",
"sendingEnabled": true,
"sendable": false,
"sendingPurpose": "marketing",
"records": [
{
"record": "DKIM",
"name": "resend._domainkey",
"type": "TXT",
"ttl": "Auto",
"status": "pending",
"value": "p=MIGfMA0..."
}
],
"createdAt": "2026-04-08T12:34:56.789Z",
"updatedAt": "2026-04-08T12:34:56.789Z"
}Update domain settings
Updates sender defaults (defaultSenderName, defaultFromEmail, defaultReplyToEmail) and/or sendingPurpose — at least one required. defaultFromEmail is the sender MAILBOX (the text before @) — the host is always this domain, so a full address is accepted and reduced to its local part; defaultReplyToEmail, by contrast, is a whole address. Live gates fail closed if a campaign still points at a transactional domain. Verification is its own action: POST /v1/domains/{domainId}/verify. Returns the bare updated row.
curl --request PATCH \
--url https://brew.new/api/v1/domains/{domainId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"defaultSenderName": "Brew",
"defaultFromEmail": "hello"
}
'import requests
url = "https://brew.new/api/v1/domains/{domainId}"
payload = {
"defaultSenderName": "Brew",
"defaultFromEmail": "hello"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({defaultSenderName: 'Brew', defaultFromEmail: 'hello'})
};
fetch('https://brew.new/api/v1/domains/{domainId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/domains/{domainId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'defaultSenderName' => 'Brew',
'defaultFromEmail' => 'hello'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/domains/{domainId}"
payload := strings.NewReader("{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/domains/{domainId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/domains/{domainId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultSenderName\": \"Brew\",\n \"defaultFromEmail\": \"hello\"\n}"
response = http.request(request)
puts response.read_body{
"domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
"domainUrl": "https://send.example.com",
"name": "send.example.com",
"region": "us-east-1",
"status": "pending",
"sendingEnabled": true,
"sendable": false,
"sendingPurpose": "marketing",
"records": [
{
"record": "DKIM",
"name": "resend._domainkey",
"type": "TXT",
"ttl": "Auto",
"status": "pending",
"value": "p=MIGfMA0..."
}
],
"createdAt": "2026-04-08T12:34:56.789Z",
"updatedAt": "2026-04-08T12:34:56.789Z"
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.
1 - 64Path Parameters
Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.
1 - 64"kx7bkh53hasmfeh5kd7sqgykt187g8ww"
Body
120320Change the domain purpose. Live gates fail closed if a campaign still points at a transactional domain; automation sends re-derive their class from the new purpose.
marketing, transactional Response
Updated.
1 - 641 - 253not_started, pending, verified, failed, temporary_failure, partially_verified, partially_failed marketing (default) or transactional. Transactional domains skip unsubscribe and send via automation sendEmail nodes (or a test send).
marketing, transactional Show child attributes
Show child attributes
Was this page helpful?