Sign in

v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
Domains

Update a domain

Allows updating of the autorenew, WhoIs Privacy and lock status of the specified domain. The request requires one, or any combination of the parameters in order to pass validation. If any of the requested updates failed, the domain will be returned to it's original state.

patch/core/v1/domains/{domainName}

Path parameters

domainNamestring required

DomainName is the domain to update.

Request body

OR
OR

Example request

{
  "autorenewEnabled": true,
  "privacyEnabled": true,
  "locked": true
}

Response

A successful response will return the updated domain.

domainNamestring required

The punycode-encoded value of the domain name.

createDatestring date-time required

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

expireDatestring date-time required

The date and time when the domain will expire.

autorenewEnabledboolean required

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

lockedboolean required

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

locksstring[]

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.

transferLockExpiresAtstring date-time

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.

privacyEnabledboolean required

Indicates if Whois Privacy is enabled for this domain.

nameserversstring[] required

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

renewalPricenumber double

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

Example response

{
  "domainName": "example.com",
  "createDate": "2023-01-15T14:30:00Z",
  "expireDate": "2025-01-15T14:30:00Z",
  "autorenewEnabled": true,
  "locked": true,
  "locks": [
    "clientTransferProhibited",
    "clientHold"
  ],
  "transferLockExpiresAt": "2023-03-16T14:30:00Z",
  "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,
      "verificationId": 12345
    },
    "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,
      "verificationId": 12345
    },
    "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,
      "verificationId": 12345
    },
    "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,
      "verificationId": 12345
    }
  },
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ],
  "renewalPrice": 12.99
}