Skip to main content
PATCH
/
v1
/
domains
/
{domainId}
Update domain settings
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@send.example.com"
}
'
import requests

url = "https://brew.new/api/v1/domains/{domainId}"

payload = {
"defaultSenderName": "Brew",
"defaultFromEmail": "hello@send.example.com"
}
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@send.example.com'})
};

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@send.example.com'
]),
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@send.example.com\"\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@send.example.com\"\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@send.example.com\"\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,
  "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"
}
{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "defaultSenderName"
}
}
{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}
{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "domains"
}
}
{
"error": {
"code": "DOMAIN_NOT_FOUND",
"type": "not_found",
"message": "The requested domain 'dom_xxx' was not found.",
"suggestion": "List domains with GET /v1/domains.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "domainId"
}
}
{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

domainId
string
required

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Required string length: 1 - 64
Example:

"kx7bkh53hasmfeh5kd7sqgykt187g8ww"

Body

application/json
defaultSenderName
string
Maximum string length: 120
defaultFromEmail
string<email>
defaultReplyToEmail
string<email>

Response

Updated.

domainId
string
required
Required string length: 1 - 64
domainUrl
string<uri>
required
name
string
required
Required string length: 1 - 253
region
string
required
status
enum<string>
required
Available options:
not_started,
pending,
verified,
failed,
temporary_failure,
partially_verified,
partially_failed
sendingEnabled
boolean
required
sendable
boolean
required
records
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
openTracking
boolean
clickTracking
boolean
verifiedAt
string<date-time>