{
"message": "Not Found",
"details": "The requested domain does not exist."
}
{
"message": "Method Not Allowed"
}
{
"message": "The 'Content-Type' header must be 'application/json' for this request."
}
{
"message": "Rate Limit Exceeded"
}
{
"message": "Internal Server Error",
"details": "Something went wrong."
}
{
"message": "The server received an invalid response from the upstream server."
}
{
"message": "Service Unavailable",
"details": "The API is offline for scheduled maintenance. See https://status.name.com for updates."
}
{
"message": "The upstream server is taking too long to respond."
}
Domains
Enable Whois Privacy
deprecated
Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.
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.
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.
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.
The cost to renew the domain. This may be required for the RenewDomain operation.
Example:
12.99
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"name.com Core API","colors":{"primary":"#1EAA50","dark":"#6EDA78"},"logo":{"light":"https://namedotcom-cdn.name.tools/media/logo/name_logo.svg","dark":"https://namedotcom-cdn.name.tools/media/logo/name_logo-white.svg","href":"https://www.name.com"},"favicon":"https://mintcdn.com/namecom/1rmHLXcBmhL0Pefk/favicon.svg?fit=max\u0026auto=format\u0026n=1rmHLXcBmhL0Pefk\u0026q=85\u0026s=e6f65c5c71b5abe116a4673dca9c256a","api":{"playground":{}},"appearance":{"default":"dark"},"seo":{"metatags":{"google-site-verification":"f-XFmxTzeRzcOF9-ocrS8hNiAemBYY4jDUL5xJwuC9M"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"namecom","hasAudioNarration":false,"actualSubdomain":"namecom","customDomains":["docs.name.com"],"gitSource":{"type":"github","owner":"namedotcom","repo":"coreapi","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ace6015aae446d0f8f844d6","collectionId":"ac21103e-fe0b-4a86-b7ac-6bf690a461c9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ace6015aae446d0f8f844d6"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ace6015aae446d0f8f844d6","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Core API Reference","count":84},{"language":"default","tag":"Domains","count":19},{"language":"default","tag":"Guides \u0026 Flows","count":18},{"language":"default","tag":"Webhook Notifications","count":16},{"language":"default","tag":"URL Forwardings","count":9},{"language":"default","tag":"Transfers","count":7},{"language":"default","tag":"Operations \u0026 Compliance","count":6},{"language":"default","tag":"DNS","count":5},{"language":"default","tag":"Email Forwardings","count":5},{"language":"default","tag":"External","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/v1/reference/domains/enable-whois-privacy","slug":"/api/v1/reference/domains/enable-whois-privacy","pageMetadata":{"openapi":"post /core/v1/domains/{domainName}:enableWhoisPrivacy","deprecated":true,"title":"Enable Whois Privacy","description":"Enables WHOIS privacy protection on a domain. **DEPRECATED** This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.","href":"/api/v1/reference/domains/enable-whois-privacy"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Enables WHOIS privacy protection on a domain. \", _jsx(_components.strong, {\n children: \"DEPRECATED\"\n }), \" This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /core/v1/domains/{domainName}:enableWhoisPrivacy","deprecated":true,"title":"Enable Whois Privacy","description":"Enables WHOIS privacy protection on a domain. **DEPRECATED** This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.","href":"/api/v1/reference/domains/enable-whois-privacy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Enables WHOIS privacy protection on a domain. **DEPRECATED** This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.","operationId":"EnableWhoisPrivacy","deprecated":true,"parameters":["c94769e9-dbf6-4797-a360-def35ebf8a25"],"requestBody":"dcd1e750-63d1-4fe3-8152-07218a04d996","responses":{"200":"7f2a872d-d60a-4eab-b800-37a54f8b9c82","400":"f349bf7c-a290-46db-a3b5-1828abffc91f","401":"52444dfc-9d1b-4f7c-9e49-afc6ac969f58","403":"29b840e7-f143-46b7-a207-8b428741122a","404":"41565582-f556-4913-88fd-5ddbeb2bc6d0","405":"0a3629bc-d9e8-4a00-8ae1-895fce13d85d","415":"ad0d1d1a-9f44-4bb5-87a5-7eea0cf4d554","429":"7fa10e69-4075-4c84-b251-dfc1dd4bc0e6","500":"7a1b29e3-06b1-4d90-98b0-edec8e5567a9","502":"707aa3ba-637e-4c71-bf2a-b26111e7e292","503":"f6a12373-729f-4a13-b75f-577733a583c1","504":"13436248-e661-4d4f-a15b-85684b22396c"},"summary":"Enable Whois Privacy","tags":["Domains"],"method":"post","type":"path","servers":["a299706b-162f-4709-8731-1da4aafad643"],"security":["d8600753-25c5-4f15-8e86-e3efcdef3502"],"path":"/core/v1/domains/{domainName}:enableWhoisPrivacy","baseUrlOptions":["https://api.dev.name.com"],"title":"Enable Whois Privacy","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c94769e9-dbf6-4797-a360-def35ebf8a25":{"description":"DomainName is the domain name to enable whoisprivacy for.","in":"path","name":"domainName","required":true,"schema":{"type":"string","isRequired":true,"description":"DomainName is the domain name to enable whoisprivacy for.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"description":"No fields are accepted. Send an empty JSON object `{}` with `Content-Type: application/json`.","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false,"description":"Empty JSON object. This operation does not accept a payload; clients must still send `Content-Type: application/json` with body `{}`.","example":{},"uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"7f2a872d-d60a-4eab-b800-37a54f8b9c82":{"content":{"application/json":{"schema":{"description":"Domain contains all relevant data for a domain.","type":"object","properties":{"domainName":{"description":"The punycode-encoded value of the domain name.","type":"string","example":"example.com","uniqueKey":"domainName","typeLabel":"string"},"createDate":{"description":"The date and time when the domain was created at the registry.","type":"string","format":"date-time","example":"2023-01-15T14:30:00Z","readOnly":true,"uniqueKey":"createDate","typeLabel":"string\u003cdate-time>"},"expireDate":{"description":"The date and time when the domain will expire.","type":"string","format":"date-time","example":"2025-01-15T14:30:00Z","readOnly":true,"uniqueKey":"expireDate","typeLabel":"string\u003cdate-time>"},"autorenewEnabled":{"description":"Indicates whether the domain is set to renew automatically before expiration.","type":"boolean","example":true,"uniqueKey":"autorenewEnabled","typeLabel":"boolean"},"locked":{"description":"Indicates if the domain is **transfer locked**, preventing transfers to another registrar.","type":"boolean","example":true,"uniqueKey":"locked","typeLabel":"boolean"},"locks":{"description":"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.","type":"array","items":{"type":"string","uniqueKey":"locks.items.[INDEX]","typeLabel":"string"},"readOnly":true,"example":["clientTransferProhibited","clientHold"],"uniqueKey":"locks","typeLabel":"string[]"},"transferLockExpiresAt":{"description":"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.","type":"string","format":"date-time","example":"2023-03-16T14:30:00Z","readOnly":true,"uniqueKey":"transferLockExpiresAt","typeLabel":"string\u003cdate-time>"},"privacyEnabled":{"description":"Indicates if Whois Privacy is enabled for this domain.","type":"boolean","example":true,"uniqueKey":"privacyEnabled","typeLabel":"boolean"},"contacts":{"description":"Contacts stores the contact information for the roles related to domains.","properties":{"admin":{"description":"Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.","type":"object","properties":{"firstName":{"oneOf":[{"description":"First name of the contact.","type":"string","example":"John","uniqueKey":"contacts.admin.firstName.oneOf.0","typeLabel":"string"},{"description":"First name of the contact.","type":"null","example":"John","uniqueKey":"contacts.admin.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name of the contact.","type":"string","example":"Doe","uniqueKey":"contacts.admin.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name of the contact.","type":"null","example":"Doe","uniqueKey":"contacts.admin.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.lastName","typeLabel":"string | null"},"companyName":{"oneOf":[{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"string","example":"Example Inc.","uniqueKey":"contacts.admin.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"null","example":"Example Inc.","uniqueKey":"contacts.admin.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.companyName","typeLabel":"string | null"},"address1":{"oneOf":[{"description":"The first line of the contact's address.","type":"string","example":"123 Main Street","uniqueKey":"contacts.admin.address1.oneOf.0","typeLabel":"string"},{"description":"The first line of the contact's address.","type":"null","example":"123 Main Street","uniqueKey":"contacts.admin.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"description":"The second line of the contact's address (optional).","type":"string","example":"Suite 400","uniqueKey":"contacts.admin.address2.oneOf.0","typeLabel":"string"},{"description":"The second line of the contact's address (optional).","type":"null","example":"Suite 400","uniqueKey":"contacts.admin.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.address2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City of the contact's address.","type":"string","example":"New York","uniqueKey":"contacts.admin.city.oneOf.0","typeLabel":"string"},{"description":"City of the contact's address.","type":"null","example":"New York","uniqueKey":"contacts.admin.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State or Province of the contact's address.","type":"string","example":"NY","uniqueKey":"contacts.admin.state.oneOf.0","typeLabel":"string"},{"description":"State or Province of the contact's address.","type":"null","example":"NY","uniqueKey":"contacts.admin.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.state","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"ZIP or Postal Code of the contact's address.","type":"string","example":"10001","uniqueKey":"contacts.admin.zip.oneOf.0","typeLabel":"string"},{"description":"ZIP or Postal Code of the contact's address.","type":"null","example":"10001","uniqueKey":"contacts.admin.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.zip","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"string","example":"US","uniqueKey":"contacts.admin.country.oneOf.0","typeLabel":"string"},{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"null","example":"US","uniqueKey":"contacts.admin.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.country","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"string","example":"john.doe@example.com","uniqueKey":"contacts.admin.email.oneOf.0","typeLabel":"string"},{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"null","example":"john.doe@example.com","uniqueKey":"contacts.admin.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.email","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15551234567","uniqueKey":"contacts.admin.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15551234567","uniqueKey":"contacts.admin.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.phone","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15557654321","uniqueKey":"contacts.admin.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15557654321","uniqueKey":"contacts.admin.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.fax","typeLabel":"string | null"},"isVerified":{"description":"Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.","type":"boolean","example":true,"readOnly":true,"uniqueKey":"contacts.admin.isVerified","typeLabel":"boolean"},"verificationId":{"oneOf":[{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"integer","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.admin.verificationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"null","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.admin.verificationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.admin.verificationId","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"contacts.admin","typeLabel":"object"},"billing":{"description":"Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.","type":"object","properties":{"firstName":{"oneOf":[{"description":"First name of the contact.","type":"string","example":"John","uniqueKey":"contacts.billing.firstName.oneOf.0","typeLabel":"string"},{"description":"First name of the contact.","type":"null","example":"John","uniqueKey":"contacts.billing.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name of the contact.","type":"string","example":"Doe","uniqueKey":"contacts.billing.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name of the contact.","type":"null","example":"Doe","uniqueKey":"contacts.billing.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.lastName","typeLabel":"string | null"},"companyName":{"oneOf":[{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"string","example":"Example Inc.","uniqueKey":"contacts.billing.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"null","example":"Example Inc.","uniqueKey":"contacts.billing.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.companyName","typeLabel":"string | null"},"address1":{"oneOf":[{"description":"The first line of the contact's address.","type":"string","example":"123 Main Street","uniqueKey":"contacts.billing.address1.oneOf.0","typeLabel":"string"},{"description":"The first line of the contact's address.","type":"null","example":"123 Main Street","uniqueKey":"contacts.billing.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"description":"The second line of the contact's address (optional).","type":"string","example":"Suite 400","uniqueKey":"contacts.billing.address2.oneOf.0","typeLabel":"string"},{"description":"The second line of the contact's address (optional).","type":"null","example":"Suite 400","uniqueKey":"contacts.billing.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.address2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City of the contact's address.","type":"string","example":"New York","uniqueKey":"contacts.billing.city.oneOf.0","typeLabel":"string"},{"description":"City of the contact's address.","type":"null","example":"New York","uniqueKey":"contacts.billing.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State or Province of the contact's address.","type":"string","example":"NY","uniqueKey":"contacts.billing.state.oneOf.0","typeLabel":"string"},{"description":"State or Province of the contact's address.","type":"null","example":"NY","uniqueKey":"contacts.billing.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.state","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"ZIP or Postal Code of the contact's address.","type":"string","example":"10001","uniqueKey":"contacts.billing.zip.oneOf.0","typeLabel":"string"},{"description":"ZIP or Postal Code of the contact's address.","type":"null","example":"10001","uniqueKey":"contacts.billing.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.zip","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"string","example":"US","uniqueKey":"contacts.billing.country.oneOf.0","typeLabel":"string"},{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"null","example":"US","uniqueKey":"contacts.billing.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.country","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"string","example":"john.doe@example.com","uniqueKey":"contacts.billing.email.oneOf.0","typeLabel":"string"},{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"null","example":"john.doe@example.com","uniqueKey":"contacts.billing.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.email","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15551234567","uniqueKey":"contacts.billing.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15551234567","uniqueKey":"contacts.billing.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.phone","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15557654321","uniqueKey":"contacts.billing.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15557654321","uniqueKey":"contacts.billing.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.fax","typeLabel":"string | null"},"isVerified":{"description":"Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.","type":"boolean","example":true,"readOnly":true,"uniqueKey":"contacts.billing.isVerified","typeLabel":"boolean"},"verificationId":{"oneOf":[{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"integer","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.billing.verificationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"null","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.billing.verificationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.billing.verificationId","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"contacts.billing","typeLabel":"object"},"registrant":{"description":"Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use RegistrantContactRequest which enforces all validation requirements.","type":"object","properties":{"firstName":{"oneOf":[{"description":"First name of the contact.","type":"string","example":"John","uniqueKey":"contacts.registrant.firstName.oneOf.0","typeLabel":"string"},{"description":"First name of the contact.","type":"null","example":"John","uniqueKey":"contacts.registrant.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name of the contact.","type":"string","example":"Doe","uniqueKey":"contacts.registrant.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name of the contact.","type":"null","example":"Doe","uniqueKey":"contacts.registrant.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.lastName","typeLabel":"string | null"},"companyName":{"oneOf":[{"description":"Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the \"Company Name\" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal \"Registered Name Holder\" (domain owner).","type":"string","example":"Example Inc.","uniqueKey":"contacts.registrant.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the \"Company Name\" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal \"Registered Name Holder\" (domain owner).","type":"null","example":"Example Inc.","uniqueKey":"contacts.registrant.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.companyName","typeLabel":"string | null"},"address1":{"oneOf":[{"description":"The first line of the contact's address.","type":"string","example":"123 Main Street","uniqueKey":"contacts.registrant.address1.oneOf.0","typeLabel":"string"},{"description":"The first line of the contact's address.","type":"null","example":"123 Main Street","uniqueKey":"contacts.registrant.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"description":"The second line of the contact's address (optional).","type":"string","example":"Suite 400","uniqueKey":"contacts.registrant.address2.oneOf.0","typeLabel":"string"},{"description":"The second line of the contact's address (optional).","type":"null","example":"Suite 400","uniqueKey":"contacts.registrant.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.address2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City of the contact's address.","type":"string","example":"New York","uniqueKey":"contacts.registrant.city.oneOf.0","typeLabel":"string"},{"description":"City of the contact's address.","type":"null","example":"New York","uniqueKey":"contacts.registrant.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State or Province of the contact's address.","type":"string","example":"NY","uniqueKey":"contacts.registrant.state.oneOf.0","typeLabel":"string"},{"description":"State or Province of the contact's address.","type":"null","example":"NY","uniqueKey":"contacts.registrant.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.state","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"ZIP or Postal Code of the contact's address.","type":"string","example":"10001","uniqueKey":"contacts.registrant.zip.oneOf.0","typeLabel":"string"},{"description":"ZIP or Postal Code of the contact's address.","type":"null","example":"10001","uniqueKey":"contacts.registrant.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.zip","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"string","example":"US","uniqueKey":"contacts.registrant.country.oneOf.0","typeLabel":"string"},{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"null","example":"US","uniqueKey":"contacts.registrant.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.country","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"string","example":"john.doe@example.com","uniqueKey":"contacts.registrant.email.oneOf.0","typeLabel":"string"},{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"null","example":"john.doe@example.com","uniqueKey":"contacts.registrant.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.email","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15551234567","uniqueKey":"contacts.registrant.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15551234567","uniqueKey":"contacts.registrant.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.phone","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15557654321","uniqueKey":"contacts.registrant.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15557654321","uniqueKey":"contacts.registrant.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.fax","typeLabel":"string | null"},"isVerified":{"description":"Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.","type":"boolean","example":true,"readOnly":true,"uniqueKey":"contacts.registrant.isVerified","typeLabel":"boolean"},"verificationId":{"oneOf":[{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"integer","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.registrant.verificationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"null","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.registrant.verificationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.registrant.verificationId","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"contacts.registrant","typeLabel":"object"},"tech":{"description":"Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.","type":"object","properties":{"firstName":{"oneOf":[{"description":"First name of the contact.","type":"string","example":"John","uniqueKey":"contacts.tech.firstName.oneOf.0","typeLabel":"string"},{"description":"First name of the contact.","type":"null","example":"John","uniqueKey":"contacts.tech.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name of the contact.","type":"string","example":"Doe","uniqueKey":"contacts.tech.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name of the contact.","type":"null","example":"Doe","uniqueKey":"contacts.tech.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.lastName","typeLabel":"string | null"},"companyName":{"oneOf":[{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"string","example":"Example Inc.","uniqueKey":"contacts.tech.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.","type":"null","example":"Example Inc.","uniqueKey":"contacts.tech.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.companyName","typeLabel":"string | null"},"address1":{"oneOf":[{"description":"The first line of the contact's address.","type":"string","example":"123 Main Street","uniqueKey":"contacts.tech.address1.oneOf.0","typeLabel":"string"},{"description":"The first line of the contact's address.","type":"null","example":"123 Main Street","uniqueKey":"contacts.tech.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"description":"The second line of the contact's address (optional).","type":"string","example":"Suite 400","uniqueKey":"contacts.tech.address2.oneOf.0","typeLabel":"string"},{"description":"The second line of the contact's address (optional).","type":"null","example":"Suite 400","uniqueKey":"contacts.tech.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.address2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City of the contact's address.","type":"string","example":"New York","uniqueKey":"contacts.tech.city.oneOf.0","typeLabel":"string"},{"description":"City of the contact's address.","type":"null","example":"New York","uniqueKey":"contacts.tech.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State or Province of the contact's address.","type":"string","example":"NY","uniqueKey":"contacts.tech.state.oneOf.0","typeLabel":"string"},{"description":"State or Province of the contact's address.","type":"null","example":"NY","uniqueKey":"contacts.tech.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.state","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"ZIP or Postal Code of the contact's address.","type":"string","example":"10001","uniqueKey":"contacts.tech.zip.oneOf.0","typeLabel":"string"},{"description":"ZIP or Postal Code of the contact's address.","type":"null","example":"10001","uniqueKey":"contacts.tech.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.zip","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"string","example":"US","uniqueKey":"contacts.tech.country.oneOf.0","typeLabel":"string"},{"description":"Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.","type":"null","example":"US","uniqueKey":"contacts.tech.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.country","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"string","example":"john.doe@example.com","uniqueKey":"contacts.tech.email.oneOf.0","typeLabel":"string"},{"description":"Email address of the contact. Must be a valid email format. The validation is performed against the `addr-spec` syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)","type":"null","example":"john.doe@example.com","uniqueKey":"contacts.tech.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.email","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15551234567","uniqueKey":"contacts.tech.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15551234567","uniqueKey":"contacts.tech.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.phone","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"string","example":"+15557654321","uniqueKey":"contacts.tech.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number of the contact. Should follow the E.164 international format: \"+[country code][number]\".","type":"null","example":"+15557654321","uniqueKey":"contacts.tech.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.fax","typeLabel":"string | null"},"isVerified":{"description":"Indicates if the contact has been verified as per ICANN requirements. If the value is `false` it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.","type":"boolean","example":true,"readOnly":true,"uniqueKey":"contacts.tech.isVerified","typeLabel":"boolean"},"verificationId":{"oneOf":[{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"integer","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.tech.verificationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"When the contact is unverified, this is the ID of the pending verification record. Use this ID with the resend verification email and verify contact endpoints. Omitted or null when the contact is verified.","type":"null","format":"int64","example":12345,"readOnly":true,"uniqueKey":"contacts.tech.verificationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.tech.verificationId","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"contacts.tech","typeLabel":"object"}},"type":"object","uniqueKey":"contacts","typeLabel":"object"},"nameservers":{"description":"The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.","type":"array","items":{"type":"string","uniqueKey":"nameservers.items.[INDEX]","typeLabel":"string"},"example":["ns1.example.com","ns2.example.com"],"uniqueKey":"nameservers","typeLabel":"string[]"},"renewalPrice":{"description":"The cost to renew the domain. This may be required for the RenewDomain operation.","type":"number","format":"double","example":12.99,"readOnly":true,"uniqueKey":"renewalPrice","typeLabel":"number\u003cdouble>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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}}},"exampleType":"generated"}},"description":"A successful response.","exampleType":"generated"},"f349bf7c-a290-46db-a3b5-1828abffc91f":{"description":"Bad request - Invalid query parameters.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Bad Request","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Additional context or information about the error","example":"'domainName' cannot be null","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional context or information about the error","example":"'domainName' cannot be null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Bad Request","details":"'domainName' cannot be null"}}},"exampleType":"generated"}},"exampleType":"generated"},"52444dfc-9d1b-4f7c-9e49-afc6ac969f58":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"29b840e7-f143-46b7-a207-8b428741122a":{"description":"Forbidden - you do not have permission to perform this action.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Permission denied","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Additional context or information about the error","example":"Failed authentication","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional context or information about the error","example":"Failed authentication","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Permission denied","details":"Failed authentication"}}},"exampleType":"generated"}},"exampleType":"generated"},"41565582-f556-4913-88fd-5ddbeb2bc6d0":{"description":"Domain not found.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Not Found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Additional context or information about the error","example":"The requested domain does not exist.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional context or information about the error","example":"The requested domain does not exist.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not Found","details":"The requested domain does not exist."}}},"exampleType":"generated"}},"exampleType":"generated"},"0a3629bc-d9e8-4a00-8ae1-895fce13d85d":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"Method Not Allowed","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Method Not Allowed"}}},"exampleType":"generated"}},"exampleType":"generated"},"ad0d1d1a-9f44-4bb5-87a5-7eea0cf4d554":{"description":"All POST, PUT, PATCH requests for this API must include the `Content-Type: application/json` header in the requests.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error","example":"The 'Content-Type' header must be 'application/json' for this request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The 'Content-Type' header must be 'application/json' for this request."}}},"exampleType":"generated"}},"exampleType":"generated"},"7fa10e69-4075-4c84-b251-dfc1dd4bc0e6":{"description":"Rate limit has been exceeded.","content":{"application/json":{"schema":{"type":"object","required":["message","details"],"properties":{"message":{"type":"string","description":"### Too Many Requests\nYou have exceeded the rate limit.\n\n**Headers returned:**\n* 'X-RateLimit-Reset': An integer (UTC epoch) indicating when you can retry.","example":"Rate Limit Exceeded","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Rate Limit Exceeded"}}},"exampleType":"generated"}},"headers":{"x-ratelimit-reset":{"description":"Unix timestamp for the time at which the current rate limit will reset.","schema":{"type":"number","example":1747668270}}},"exampleType":"generated"},"7a1b29e3-06b1-4d90-98b0-edec8e5567a9":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error.","example":"Internal Server Error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Additional context or information about the error.","example":"Something went wrong.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional context or information about the error.","example":"Something went wrong.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal Server Error","details":"Something went wrong."}}},"exampleType":"generated"}},"exampleType":"generated"},"707aa3ba-637e-4c71-bf2a-b26111e7e292":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error.","example":"The server received an invalid response from the upstream server.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The server received an invalid response from the upstream server."}}},"exampleType":"generated"}},"exampleType":"generated"},"f6a12373-729f-4a13-b75f-577733a583c1":{"description":"Service Unavailable — returned during scheduled maintenance when the API is offline. See https://status.name.com for updates.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error.","example":"Service Unavailable","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Additional context or information about the error.","example":"The API is offline for scheduled maintenance. See https://status.name.com for updates.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional context or information about the error.","example":"The API is offline for scheduled maintenance. See https://status.name.com for updates.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Service Unavailable","details":"The API is offline for scheduled maintenance. See https://status.name.com for updates."}}},"exampleType":"generated"}},"exampleType":"generated"},"13436248-e661-4d4f-a15b-85684b22396c":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable message providing more details about the error.","example":"The upstream server is taking too long to respond.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The upstream server is taking too long to respond."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d8600753-25c5-4f15-8e86-e3efcdef3502":{"BasicAuth":{"scheme":"basic","type":"http","description":"Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic \u003cbase64(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.","scopes":[],"schemeName":"BasicAuth"}}},"servers":{"a299706b-162f-4709-8731-1da4aafad643":{"description":"Testing","url":"https://api.dev.name.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"basic","type":"http","description":"Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic \u003cbase64(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.","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic \u003cbase64(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.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"api/v1/namecom.api.yaml"},"subdomain":"namecom","siteName":"name.com Core API","title":"Enable Whois Privacy - name.com Core API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T20:32:19.488Z","originalFileLocation":"api/v1/reference/domains/enable-whois-privacy.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\">\u003cmeta data-mint-head name=\"application-name\" content=\"name.com Core API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Enable Whois Privacy - name.com Core API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"name.com Core API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://namecom.mintlify.app/_mintlify/api/og/v2?division=Domains\u0026amp;title=Enable+Whois+Privacy\u0026amp;description=Enables+WHOIS+privacy+protection+on+a+domain.+**DEPRECATED**+This+endpoint+is+deprecated+in+favor+of+the+new+UpdateDomain+API.+This+will+be+removed+in+a+future+\u0026amp;theme=a954cb13cd71ba157cb20fc0\u0026amp;signature=a7480fe1b11adf3bbfefbb9e5ebb3b0e409300e0b87f4436d50c472a7f8dccc9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Enable Whois Privacy - name.com Core API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://namecom.mintlify.app/_mintlify/api/og/v2?division=Domains\u0026amp;title=Enable+Whois+Privacy\u0026amp;description=Enables+WHOIS+privacy+protection+on+a+domain.+**DEPRECATED**+This+endpoint+is+deprecated+in+favor+of+the+new+UpdateDomain+API.+This+will+be+removed+in+a+future+\u0026amp;theme=a954cb13cd71ba157cb20fc0\u0026amp;signature=a7480fe1b11adf3bbfefbb9e5ebb3b0e409300e0b87f4436d50c472a7f8dccc9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/namecom/YtIhkLytNOiNFb-Q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"name.com Core API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1EAA50\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"f-XFmxTzeRzcOF9-ocrS8hNiAemBYY4jDUL5xJwuC9M\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/v1/reference/domains/enable-whois-privacy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.name.com/#organization\",\"name\":\"name.com Core API\",\"url\":\"https://docs.name.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://namedotcom-cdn.name.tools/media/logo/name_logo.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.name.com#website\",\"name\":\"name.com Core API\",\"url\":\"https://docs.name.com\",\"publisher\":{\"@id\":\"https://docs.name.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy#webpage\",\"url\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy\",\"name\":\"Enable Whois Privacy\",\"description\":\"Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\",\"dateModified\":\"2026-01-27T20:32:19.488Z\",\"isPartOf\":{\"@id\":\"https://docs.name.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API Reference\",\"item\":\"https://docs.name.com/api/v1/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Domains\",\"item\":\"https://docs.name.com/api/v1/reference/domains/list-domains\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Enable Whois Privacy\",\"item\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy#apireference\",\"headline\":\"Enable Whois Privacy\",\"name\":\"Enable Whois Privacy\",\"description\":\"Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.\",\"url\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.name.com/api/v1/reference/domains/enable-whois-privacy#webpage\"},\"dateModified\":\"2026-01-27T20:32:19.488Z\",\"publisher\":{\"@id\":\"https://docs.name.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.name.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"name.com Core API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"name.com Core API","nav":{"global":null,"groups":[{"group":"API Home","pages":[{"title":"name.com Core API Documentation","href":"/index"}]},{"group":"Guides \u0026 Flows","pages":[{"title":"v4 to CORE API Migration","href":"/guides/migration-guide"},{"group":"Setup","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Getting Started","href":"/guides/getting-started"},{"title":"Testing Environment","href":"/guides/testing-environment"}]},{"group":"Build \u0026 Launch","pages":[{"title":"Reseller Quickstart","href":"/guides/quickstart"},{"title":"Domain Purchase Pricing","href":"/guides/domain-pricing"},{"title":"Quickstart TLD List","href":"/guides/quickstart-recommended-tlds"}]},{"group":"Operations \u0026 Compliance","pages":[{"title":"Contact Verification Compliance","href":"/guides/contact-verification"},{"title":"Domain Renewals \u0026 Expiration","href":"/guides/domain-renewals-expiration"},{"title":"Funding Your name.com Account","href":"/guides/funding-your-namecom-account"},{"title":"HMAC Signature Verification","href":"/guides/hmac-examples"},{"title":"Registrant Communications","href":"/guides/registrant-communications"},{"title":"Understanding Domain Locks","href":"/guides/domain-locks"}]},{"group":"Flows","pages":[{"title":"Claims Flow","href":"/guides/claims-flow"},{"title":"External Transfers Flow","href":"/guides/external-transfers-flow"},{"title":"Refunds Flow","href":"/guides/refunds-flow"}]},{"group":"MCP Integrations","pages":[{"title":"API Docs MCP","href":"/integrations/mcp/api-docs-mcp"},{"title":"name.com MCP","href":"/integrations/mcp/namecom-mcp"}]}]},{"group":"Official SDKs","tag":"NEW","pages":[{"title":"SDK Quickstart","href":"/sdks/index"}]},{"group":"Core API Reference","pages":[{"title":"API Overview","href":"/api/v1/overview"},{"group":"Hello","pages":[{"openapi":"get /core/v1/hello","title":"Hello","href":"/api/v1/reference/hello/hello"}]},{"group":"Account Info","pages":[{"openapi":"get /core/v1/accountinfo/balance","title":"Check Account Balance","href":"/api/v1/reference/account-info/check-account-balance"}]},{"group":"Contact Verification","pages":[{"openapi":"get /core/v1/contacts/unverified","title":"List Unverified Contacts","href":"/api/v1/reference/contact-verification/list-unverified-contacts"},{"openapi":"post /core/v1/contacts/verify/{verificationId}","title":"Verify Contact","href":"/api/v1/reference/contact-verification/verify-contact"},{"openapi":"post /core/v1/contacts/verify/{verificationId}:resend","title":"Resend Contact Verification Email","href":"/api/v1/reference/contact-verification/resend-verification-email"}]},{"group":"Domains","pages":[{"openapi":"get /core/v1/domains","title":"List Domains","href":"/api/v1/reference/domains/list-domains"},{"openapi":"post /core/v1/domains","title":"Create Domain","href":"/api/v1/reference/domains/create-domain"},{"openapi":"get /core/v1/domains/{domainName}","title":"Get Domain","href":"/api/v1/reference/domains/get-domain"},{"openapi":"patch /core/v1/domains/{domainName}","title":"Update a domain","href":"/api/v1/reference/domains/update-a-domain"},{"openapi":"get /core/v1/domains/{domainName}:getAuthCode","title":"Get Auth Code For Domain","href":"/api/v1/reference/domains/get-auth-code-for-domain"},{"openapi":"get /core/v1/domains/{domainName}:getPricing","title":"Get Pricing For Domain","href":"/api/v1/reference/domains/get-pricing-for-domain"},{"openapi":"post /core/v1/domains/{domainName}:purchasePrivacy","title":"Purchase Privacy","href":"/api/v1/reference/domains/purchase-privacy"},{"openapi":"post /core/v1/domains/{domainName}:renew","title":"Renew Domain","href":"/api/v1/reference/domains/renew-domain"},{"openapi":"post /core/v1/domains/{domainName}:setContacts","title":"Set Contacts","href":"/api/v1/reference/domains/set-contacts"},{"openapi":"post /core/v1/domains/{domainName}:setNameservers","title":"Set Nameservers","href":"/api/v1/reference/domains/set-nameservers"},{"openapi":"post /core/v1/domains:checkAvailability","title":"Check Availability","href":"/api/v1/reference/domains/check-availability"},{"openapi":"post /core/v1/domains:search","title":"Search","href":"/api/v1/reference/domains/search"},{"openapi":"post /core/v1/zonecheck","title":"Zone Check","href":"/api/v1/reference/domains/zone-check"},{"openapi":"post /core/v1/domains/{domainName}:disableAutorenew","deprecated":true,"title":"Disable Autorenew","href":"/api/v1/reference/domains/disable-autorenew"},{"openapi":"post /core/v1/domains/{domainName}:disableWhoisPrivacy","deprecated":true,"title":"Disable Whois Privacy","href":"/api/v1/reference/domains/disable-whois-privacy"},{"openapi":"post /core/v1/domains/{domainName}:enableAutorenew","deprecated":true,"title":"Enable Autorenew","description":"Turns on automatic renewal for a domain. **DEPRECATED** This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.","href":"/api/v1/reference/domains/enable-autorenew"},{"openapi":"post /core/v1/domains/{domainName}:enableWhoisPrivacy","deprecated":true,"title":"Enable Whois Privacy","href":"/api/v1/reference/domains/enable-whois-privacy"},{"openapi":"post /core/v1/domains/{domainName}:lock","deprecated":true,"title":"Lock Domain","description":"Locks a domain to prevent it from being transferred. **DEPRECATED** This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.","href":"/api/v1/reference/domains/lock-domain"},{"openapi":"post /core/v1/domains/{domainName}:unlock","deprecated":true,"title":"Unlock Domain","href":"/api/v1/reference/domains/unlock-domain"}]},{"group":"Domain Info","pages":[{"openapi":"get /core/v1/domaininfo/requirementsV2/{tld}","title":"Get TLD Requirements as JSON Schema","href":"/api/v1/reference/domain-info/get-specific-tld-requirements-v2"},{"openapi":"get /core/v1/domaininfo/requirements/{tld}","title":"Get Specific TLD Requirements","href":"/api/v1/reference/domain-info/get-specific-tld-requirements"},{"openapi":"post /core/v1/domaininfo/claims/{domain}","title":"Check Domain Claims","href":"/api/v1/reference/domain-info/check-domain-claims"}]},{"group":"DNS","pages":[{"openapi":"get /core/v1/domains/{domainName}/records","title":"List Records","href":"/api/v1/reference/dns/list-records"},{"openapi":"post /core/v1/domains/{domainName}/records","title":"Create Record","href":"/api/v1/reference/dns/create-record"},{"openapi":"get /core/v1/domains/{domainName}/records/{id}","title":"Get Record","href":"/api/v1/reference/dns/get-record"},{"openapi":"put /core/v1/domains/{domainName}/records/{id}","title":"Update Record","href":"/api/v1/reference/dns/update-record"},{"openapi":"delete /core/v1/domains/{domainName}/records/{id}","title":"Delete Record","href":"/api/v1/reference/dns/delete-record"}]},{"group":"DNSSECs","pages":[{"openapi":"get /core/v1/domains/{domainName}/dnssec","title":"List DNSSECs","href":"/api/v1/reference/dnssecs/list-dnssecs"},{"openapi":"post /core/v1/domains/{domainName}/dnssec","title":"Create DNSSEC","href":"/api/v1/reference/dnssecs/create-dnssec"},{"openapi":"get /core/v1/domains/{domainName}/dnssec/{digest}","title":"Get DNSSEC","href":"/api/v1/reference/dnssecs/get-dnssec"},{"openapi":"delete /core/v1/domains/{domainName}/dnssec/{digest}","title":"Delete DNSSEC","href":"/api/v1/reference/dnssecs/delete-dnssec"}]},{"group":"Email Forwardings","pages":[{"openapi":"get /core/v1/domains/{domainName}/email/forwarding","title":"List Email Forwardings","href":"/api/v1/reference/email-forwardings/list-email-forwardings"},{"openapi":"post /core/v1/domains/{domainName}/email/forwarding","title":"Create Email Forwarding","href":"/api/v1/reference/email-forwardings/create-email-forwarding"},{"openapi":"get /core/v1/domains/{domainName}/email/forwarding/{emailBox}","title":"Get Email Forwarding","href":"/api/v1/reference/email-forwardings/get-email-forwarding"},{"openapi":"put /core/v1/domains/{domainName}/email/forwarding/{emailBox}","title":"Update Email Forwarding","href":"/api/v1/reference/email-forwardings/update-email-forwarding"},{"openapi":"delete /core/v1/domains/{domainName}/email/forwarding/{emailBox}","title":"Delete Email Forwarding","href":"/api/v1/reference/email-forwardings/delete-email-forwarding"}]},{"group":"Orders","pages":[{"openapi":"get /core/v1/orders","title":"List Orders","href":"/api/v1/reference/orders/list-orders"},{"openapi":"get /core/v1/orders/{orderId}","title":"Get Order","href":"/api/v1/reference/orders/get-order"}]},{"group":"Refunds","pages":[{"openapi":"post /core/v1/refund","title":"Process Refund","href":"/api/v1/reference/refunds/process-refund"}]},{"group":"Premium Domains","pages":[{"openapi":"get /core/v1/premiumdomainslist","title":"Download Premium Domain Lists","href":"/api/v1/reference/premium-domains/download-premium-domain-lists"}]},{"group":"TLD Pricing","pages":[{"openapi":"get /core/v1/tldpricing","title":"TLD Price List","href":"/api/v1/reference/tld-pricing/tld-price-list"}]},{"group":"Transfers","pages":[{"title":"Check Transfer Eligibility","openapi":"get /core/v1/transfers/eligibility/{domainName}","href":"/api/v1/reference/transfers/get-transfer-eligibility"},{"group":"External","pages":[{"title":"List Transfers","openapi":"get /core/v1/transfers","href":"/api/v1/reference/transfers/list-transfers"},{"title":"Get Transfer Status","openapi":"get /core/v1/transfers/{domainName}","href":"/api/v1/reference/transfers/get-transfer"},{"title":"Create External Transfer In","openapi":"post /core/v1/transfers","href":"/api/v1/reference/transfers/create-transfer"},{"title":"Cancel External Transfer In","openapi":"post /core/v1/transfers/{domainName}:cancel","href":"/api/v1/reference/transfers/cancel-transfer"},{"title":"Cancel External Transfer Out","openapi":"post /core/v1/transfers/external/out/{domainName}:cancel","href":"/api/v1/reference/transfers/cancel-external-transfer-out"}]},{"group":"Internal","pages":[{"title":"Create Internal Transfer In","openapi":"post /core/v1/transfers/internal/in","href":"/api/v1/reference/transfers/create-internal-transfer-in"}]}]},{"group":"URL Forwardings","pages":[{"openapi":"post /core/v1/domains/{domainName}/url/forwarding","title":"Create URLForwarding","href":"/api/v1/reference/url-forwardings/create-urlforwarding"},{"openapi":"get /core/v1/urlforwarding/{domainName}","title":"List URL Forwardings by domain","href":"/api/v1/reference/url-forwardings/list-urlforwardings-by-domain"},{"openapi":"get /core/v1/urlforwarding/{domainName}/{id}","title":"Get URL Forwarding by ID","href":"/api/v1/reference/url-forwardings/get-urlforwarding-by-id"},{"openapi":"patch /core/v1/urlforwarding/{domainName}/{id}","title":"Update URL Forwarding by ID","href":"/api/v1/reference/url-forwardings/update-urlforwarding-by-id"},{"openapi":"delete /core/v1/urlforwarding/{domainName}/{id}","title":"Delete URL Forwarding by ID","href":"/api/v1/reference/url-forwardings/delete-urlforwarding-by-id"},{"openapi":"get /core/v1/domains/{domainName}/url/forwarding","deprecated":true,"title":"List URLForwardings","href":"/api/v1/reference/url-forwardings/list-urlforwardings"},{"openapi":"get /core/v1/domains/{domainName}/url/forwarding/{host}","deprecated":true,"title":"Get URLForwarding","href":"/api/v1/reference/url-forwardings/get-urlforwarding"},{"openapi":"put /core/v1/domains/{domainName}/url/forwarding/{host}","deprecated":true,"title":"Update URLForwarding","href":"/api/v1/reference/url-forwardings/update-urlforwarding"},{"openapi":"delete /core/v1/domains/{domainName}/url/forwarding/{host}","deprecated":true,"title":"Delete URLForwarding","href":"/api/v1/reference/url-forwardings/delete-urlforwarding"}]},{"group":"Vanity Nameservers","pages":[{"openapi":"get /core/v1/domains/{domainName}/vanity_nameservers","title":"List Vanity Nameservers","href":"/api/v1/reference/vanity-nameservers/list-vanity-nameservers"},{"openapi":"post /core/v1/domains/{domainName}/vanity_nameservers","title":"Create Vanity Nameserver","href":"/api/v1/reference/vanity-nameservers/create-vanity-nameserver"},{"openapi":"get /core/v1/domains/{domainName}/vanity_nameservers/{hostname}","title":"Get Vanity Nameserver","href":"/api/v1/reference/vanity-nameservers/get-vanity-nameserver"},{"openapi":"put /core/v1/domains/{domainName}/vanity_nameservers/{hostname}","title":"Update Vanity Nameserver IP","href":"/api/v1/reference/vanity-nameservers/update-vanity-nameserver-ip"},{"openapi":"delete /core/v1/domains/{domainName}/vanity_nameservers/{hostname}","title":"Delete Vanity Nameserver","href":"/api/v1/reference/vanity-nameservers/delete-vanity-nameserver"}]},{"group":"Webhook Notifications","pages":[{"title":"Webhooks Overview","href":"/api/v1/reference/webhook-notifications/overview"},{"group":"Subscriptions","pages":[{"title":"Get Subscribed Notifications","openapi":"get /core/v1/notifications","href":"/api/v1/reference/webhook-notifications/get-subscribed-notifications"},{"title":"Subscribe to Notification","openapi":"post /core/v1/notifications","href":"/api/v1/reference/webhook-notifications/subscribe-to-notification"},{"title":"Modify Subscription","openapi":"put /core/v1/notifications/{id}","href":"/api/v1/reference/webhook-notifications/modify-subscription"},{"title":"Delete Subscription","openapi":"delete /core/v1/notifications/{id}","href":"/api/v1/reference/webhook-notifications/delete-subscription"}]},{"group":"Account Events","pages":[{"title":"Account Credit Balance Change","openapi":"webhook accountCreditBalanceChange","href":"/api/v1/reference/webhook-notifications/account-credit-balance-change"}]},{"group":"Contact Events","pages":[{"title":"Contact Verification Status Change","openapi":"webhook contactVerificationStatusChange","href":"/api/v1/reference/webhook-notifications/contact-verification-status-change"}]},{"group":"Domain Events","pages":[{"title":"Domain Expiration","openapi":"webhook domainExpiration","href":"/api/v1/reference/webhook-notifications/domain-expiration"},{"title":"Domain Lock Status Change","openapi":"webhook domainLockStatusChange","href":"/api/v1/reference/webhook-notifications/domain-lock-status-change"},{"title":"Domain Registry Compliance Notice","openapi":"webhook domainRegistryComplianceNotice","href":"/api/v1/reference/webhook-notifications/domain-registry-compliance-notice"},{"title":"Domain Registry Rejection","openapi":"webhook domainRegistryRejection","href":"/api/v1/reference/webhook-notifications/domain-registry-rejection"},{"title":"Domain Removal","openapi":"webhook accountDomainRemoval","href":"/api/v1/reference/webhook-notifications/account-domain-removal"}]},{"group":"Transfers — External","pages":[{"title":"Domain Transfer In Status Change","openapi":"webhook domainTransferStatusChange","href":"/api/v1/reference/webhook-notifications/domain-transfer-status-change"},{"title":"Domain Transfer Out Status Change","openapi":"webhook domainTransferOutStatusChange","href":"/api/v1/reference/webhook-notifications/domain-transfer-out-status-change"}]},{"group":"Transfers — Internal","pages":[{"title":"Internal Transfer In Status Change","openapi":"webhook domainTransferInternalInStatusChange","href":"/api/v1/reference/webhook-notifications/domain-transfer-internal-in-status-change"},{"title":"Internal Transfer Out Status Change","openapi":"webhook domainTransferInternalOutStatusChange","href":"/api/v1/reference/webhook-notifications/domain-transfer-internal-out-status-change"}]}]}]},{"group":"Resources","pages":[{"title":"FAQ \u0026 Troubleshooting","href":"/resources/faq"},{"title":"Changelog","href":"/api/v1/changelog"}]}]},"basePath":"","title":"Enable Whois Privacy - name.com Core API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}