Update a sending domain
curl --request PATCH \
--url https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"trackingEnabled": true,
"trackingHostname": "<string>",
"clickTrackingEnabled": true,
"openTrackingEnabled": true,
"unsubscribesEnabled": true,
"returnPathEnabled": true
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}"
payload = {
"dkimEnabled": True,
"spfEnabled": True,
"dmarcEnabled": True,
"trackingEnabled": True,
"trackingHostname": "<string>",
"clickTrackingEnabled": True,
"openTrackingEnabled": True,
"unsubscribesEnabled": True,
"returnPathEnabled": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dkimEnabled: true,
spfEnabled: true,
dmarcEnabled: true,
trackingEnabled: true,
trackingHostname: '<string>',
clickTrackingEnabled: true,
openTrackingEnabled: true,
unsubscribesEnabled: true,
returnPathEnabled: true
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}', 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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}",
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([
'dkimEnabled' => true,
'spfEnabled' => true,
'dmarcEnabled' => true,
'trackingEnabled' => true,
'trackingHostname' => '<string>',
'clickTrackingEnabled' => true,
'openTrackingEnabled' => true,
'unsubscribesEnabled' => true,
'returnPathEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}"
payload := strings.NewReader("{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "mail.example.com",
"status": "provisioning",
"verifiedAt": "2023-11-07T05:31:56Z",
"lastVerificationAttempt": "2023-11-07T05:31:56Z",
"verificationAttempts": 123,
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"trackingEnabled": true,
"trackingHostname": "track.example.com",
"clickTrackingEnabled": true,
"openTrackingEnabled": true,
"unsubscribesEnabled": true,
"returnPathEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domainDnsRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendingDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "TXT",
"name": "brudcast._domainkey.example.com",
"value": "v=DKIM1; k=rsa; p=MIGfMA0...",
"purpose": "verification",
"description": "<string>",
"priority": 10,
"ttl": 3600,
"isVerified": true,
"scope": "sending",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Sending Domains
Update a sending domain
Changes the authentication and tracking settings of a domain. Requires the domains:write scope.
PATCH
/
api
/
v1
/
user
/
sending-domains
/
{id}
Update a sending domain
curl --request PATCH \
--url https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"trackingEnabled": true,
"trackingHostname": "<string>",
"clickTrackingEnabled": true,
"openTrackingEnabled": true,
"unsubscribesEnabled": true,
"returnPathEnabled": true
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}"
payload = {
"dkimEnabled": True,
"spfEnabled": True,
"dmarcEnabled": True,
"trackingEnabled": True,
"trackingHostname": "<string>",
"clickTrackingEnabled": True,
"openTrackingEnabled": True,
"unsubscribesEnabled": True,
"returnPathEnabled": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dkimEnabled: true,
spfEnabled: true,
dmarcEnabled: true,
trackingEnabled: true,
trackingHostname: '<string>',
clickTrackingEnabled: true,
openTrackingEnabled: true,
unsubscribesEnabled: true,
returnPathEnabled: true
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}', 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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}",
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([
'dkimEnabled' => true,
'spfEnabled' => true,
'dmarcEnabled' => true,
'trackingEnabled' => true,
'trackingHostname' => '<string>',
'clickTrackingEnabled' => true,
'openTrackingEnabled' => true,
'unsubscribesEnabled' => true,
'returnPathEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}"
payload := strings.NewReader("{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-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://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/sending-domains/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dkimEnabled\": true,\n \"spfEnabled\": true,\n \"dmarcEnabled\": true,\n \"trackingEnabled\": true,\n \"trackingHostname\": \"<string>\",\n \"clickTrackingEnabled\": true,\n \"openTrackingEnabled\": true,\n \"unsubscribesEnabled\": true,\n \"returnPathEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "mail.example.com",
"status": "provisioning",
"verifiedAt": "2023-11-07T05:31:56Z",
"lastVerificationAttempt": "2023-11-07T05:31:56Z",
"verificationAttempts": 123,
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"trackingEnabled": true,
"trackingHostname": "track.example.com",
"clickTrackingEnabled": true,
"openTrackingEnabled": true,
"unsubscribesEnabled": true,
"returnPathEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domainDnsRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendingDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "TXT",
"name": "brudcast._domainkey.example.com",
"value": "v=DKIM1; k=rsa; p=MIGfMA0...",
"purpose": "verification",
"description": "<string>",
"priority": 10,
"ttl": 3600,
"isVerified": true,
"scope": "sending",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
apiKeyapiKeyBearer
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.
Path Parameters
Body
application/json