Skip to main content
POST
Purchase Privacy

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

X-Idempotency-Key
string

A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.

Example:

"083910ef-04e4-4bd1-a0bf-3737fe005ca8"

Path Parameters

domainName
string
required

DomainName is the domain to enable or extend Whois Privacy for.

Body

application/json

Request body for enabling or extending WHOIS privacy on a domain.

purchasePrice
number<double>

WHOIS privacy is free for API users. This field does not add a privacy fee.

years
integer<int32>
default:1

Years is the number of years to enable or extend Whois Privacy for. Years defaults to 1 and cannot be more then the domain expiration date.

Response

A successful response.

PrivacyResponse contains the updated domain info as well as the order info for the Whois Privacy that was enabled or extended.

order
integer<int32>
required

Order is an identifier for this purchase.

totalPaid
number<double>
required

TotalPaid is the total amount paid, including VAT when applicable. Whois Privacy is free and is not included in this amount.

Example:

0

domain
object

The response format for a domain.