Update a domain
curl --request PATCH \
--url https://api.brimble.io/core/v1/domains/{domainId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"teamId": "<string>",
"redirect": {
"url": "<string>"
}
}
'import requests
url = "https://api.brimble.io/core/v1/domains/{domainId}"
payload = {
"name": "<string>",
"teamId": "<string>",
"redirect": { "url": "<string>" }
}
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', teamId: '<string>', redirect: {url: '<string>'}})
};
fetch('https://api.brimble.io/core/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://api.brimble.io/core/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([
'name' => '<string>',
'teamId' => '<string>',
'redirect' => [
'url' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-key: <api-key>"
],
]);
$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://api.brimble.io/core/v1/domains/{domainId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-brimble-key", "<api-key>")
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://api.brimble.io/core/v1/domains/{domainId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/domains/{domainId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Domain updated successfully",
"data": {
"name": "<unknown>",
"id": "<unknown>",
"primary": "<unknown>",
"project": "<unknown>",
"preview": "<unknown>",
"user_id": "<unknown>",
"team_id": "<unknown>",
"isCustom": true,
"records": "<unknown>",
"nameserver": "<unknown>",
"nameservers": "<unknown>",
"redirect": "<unknown>",
"active": true,
"enabled": "<unknown>",
"purchased": "<unknown>",
"wildcard_enabled": true,
"wildcard_verified": true,
"edge": "<unknown>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"isExpired": true
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Domains
Update a domain
API key scope: domain.update
Team role permission: domain.update
PATCH
/
v1
/
domains
/
{domainId}
Update a domain
curl --request PATCH \
--url https://api.brimble.io/core/v1/domains/{domainId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"teamId": "<string>",
"redirect": {
"url": "<string>"
}
}
'import requests
url = "https://api.brimble.io/core/v1/domains/{domainId}"
payload = {
"name": "<string>",
"teamId": "<string>",
"redirect": { "url": "<string>" }
}
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', teamId: '<string>', redirect: {url: '<string>'}})
};
fetch('https://api.brimble.io/core/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://api.brimble.io/core/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([
'name' => '<string>',
'teamId' => '<string>',
'redirect' => [
'url' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-key: <api-key>"
],
]);
$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://api.brimble.io/core/v1/domains/{domainId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-brimble-key", "<api-key>")
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://api.brimble.io/core/v1/domains/{domainId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/domains/{domainId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"teamId\": \"<string>\",\n \"redirect\": {\n \"url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Domain updated successfully",
"data": {
"name": "<unknown>",
"id": "<unknown>",
"primary": "<unknown>",
"project": "<unknown>",
"preview": "<unknown>",
"user_id": "<unknown>",
"team_id": "<unknown>",
"isCustom": true,
"records": "<unknown>",
"nameserver": "<unknown>",
"nameservers": "<unknown>",
"redirect": "<unknown>",
"active": true,
"enabled": "<unknown>",
"purchased": "<unknown>",
"wildcard_enabled": true,
"wildcard_verified": true,
"edge": "<unknown>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"isExpired": true
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Body
application/json
Last modified on October 10, 2026
Was this page helpful?