Skip to main content
PATCH
Update a domain

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.

Path Parameters

domainName
string
required

DomainName is the domain to update.

Body

application/json
autorenewEnabled
boolean
required

Enable or disable automatic renewal for the domain.

Example:

true

privacyEnabled
boolean

Enable or disable Whois privacy for the domain.

Example:

true

locked
boolean

Set the transfer lock status for the domain

Example:

true

Response

A successful response will return the updated domain.

The response format for a domain.

domainName
string
required

The punycode-encoded value of the domain name.

Example:

"example.com"

createDate
string<date-time>
required
read-only

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

Example:

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

expireDate
string<date-time>
required
read-only

The date and time when the domain will expire.

Example:

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

autorenewEnabled
boolean
required

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

Example:

true

locked
boolean
required

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

Example:

true

privacyEnabled
boolean
required

Indicates if Whois Privacy is enabled for this domain.

Example:

true

contacts
object
required

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

nameservers
string[]
required

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

Example:
locks
string[]
read-only

List of all registry locking statuses currently applied to the domain. Use this to see which locks are active (e.g. clientTransferProhibited, clientHold). Empty when the domain has no locks applied.

Example:
transferLockExpiresAt
string<date-time>
read-only

When present, the domain has an active ICANN-mandated transfer lock (new registration, transfer-in, or material registrant contact change) that blocks client unlock via the API until this time. When omitted, there is no active policy transfer lock with a known expiry — the domain may still be locked (locked: true) due to a voluntary user lock. Does not represent RegistrarLock, AccountLock, verification holds, trademark-claim locks, or admin TransferLock with no expiry date.

Example:

"2023-03-16T14:30:00Z"

renewalPrice
number<double>
read-only

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

Example:

12.99