Skip to main content
POST
/
core
/
v1
/
domains
/
{domainName}
:enableWhoisPrivacy
Enable Whois Privacy
curl --request POST \
  --url https://api.dev.name.com/core/v1/domains/{domainName}:enableWhoisPrivacy \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: <content-type>'
{
  "domainName": "example.com",
  "createDate": "2023-01-15T14:30:00Z",
  "expireDate": "2025-01-15T14:30:00Z",
  "autorenewEnabled": true,
  "locked": true,
  "privacyEnabled": true,
  "contacts": {
    "admin": {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Example Inc.",
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US",
      "email": "john.doe@example.com",
      "phone": "+15551234567",
      "fax": "+15557654321",
      "isVerified": true
    },
    "billing": {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Example Inc.",
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US",
      "email": "john.doe@example.com",
      "phone": "+15551234567",
      "fax": "+15557654321",
      "isVerified": true
    },
    "registrant": {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Example Inc.",
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US",
      "email": "john.doe@example.com",
      "phone": "+15551234567",
      "fax": "+15557654321",
      "isVerified": true
    },
    "tech": {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Example Inc.",
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US",
      "email": "john.doe@example.com",
      "phone": "+15551234567",
      "fax": "+15557654321",
      "isVerified": true
    }
  },
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ],
  "renewalPrice": 12.99
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Headers

​
Content-Type
enum<string>
required

Required Content-Type Header for POST requests.

Available options:
application/json

Path Parameters

​
domainName
string
required

DomainName is the domain name to enable whoisprivacy for.

Response

A successful response.

Domain contains all relevant data for a domain.

​
domainName
string

The punycode-encoded value of the domain name.

Example:

"example.com"

​
createDate
string<date-time>

The date and time when the domain was created at the registry.

Example:

"2023-01-15T14:30:00Z"

​
expireDate
string<date-time>

The date and time when the domain will expire.

Example:

"2025-01-15T14:30:00Z"

​
autorenewEnabled
boolean

Indicates whether the domain is set to renew automatically before expiration.

Example:

true

​
locked
boolean

Indicates if the domain is locked, preventing transfers to another registrar.

Example:

true

​
privacyEnabled
boolean

Indicates if Whois Privacy is enabled for this domain.

Example:

true

​
contacts
object

Contacts stores the contact information for the roles related to domains.

​
nameservers
string[]

The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.

Example:
["ns1.example.com", "ns2.example.com"]
​
renewalPrice
number

The cost to renew the domain. This may be required for the RenewDomain operation.

Example:

12.99

⌘I