Skip to main content
PUT
/
registrar
/
v1
/
domains
/
{domain_name}
/
privacy
Toggle domain privacy protection
curl --request PUT \
  --url https://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'
import requests

url = "https://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy"

payload = { "enabled": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true})
};

fetch('https://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy', 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://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true
]),
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://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy"

payload := strings.NewReader("{\n \"enabled\": true\n}")

req, _ := http.NewRequest("PUT", 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.put("https://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.atom.com/api/registrar/v1/domains/{domain_name}/privacy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Privacy protection updated successfully",
  "data": {
    "domain_name": "example.com",
    "privacy_protect": true
  }
}
{
"success": true,
"message": "Please verify your contact info via email to complete privacy protection update",
"data": {
"domain_name": "example.com",
"privacy_protect": true,
"verification_required": true
}
}
{
"success": false,
"error": "Bad Request",
"message": "Invalid input provided"
}
{
"success": false,
"error": "Unauthorized",
"message": "Invalid registrar API token or access has been revoked. Please request registrar API access from your dashboard."
}
{
"success": false,
"error": "Bad Request",
"message": "Invalid input provided"
}
{
"success": false,
"error": "Bad Request",
"message": "Invalid input provided"
}
{
"success": false,
"error": "Bad Request",
"message": "Invalid input provided"
}

Authorizations

Authorization
string
header
required

Registrar API Bearer token. Obtain from dashboard at /dashboard/seller/api-access after requesting Registrar API access.

Path Parameters

domain_name
string
required

Domain name (e.g., 'example.com')

Body

application/json
enabled
boolean
required

Enable or disable WHOIS privacy protection

Example:

true

Response

Privacy protection updated successfully

success
boolean
Example:

true

message
string
Example:

"Privacy protection updated successfully"

data
object