API Home
Guides & Flows
Core API Overview
name.com Core API Reference
- GETList Domains
- POSTCreate Domain
- GETGet Domain
- PATCHUpdate a domain
- GETGet Auth Code For Domain
- GETGet Pricing For Domain
- POSTPurchase Privacy
- POSTRenew Domain
- POSTSet Contacts
- POSTSet Nameservers
- POSTCheck Availability
- POSTSearch
- POSTZone Check
- POSTDisable Autorenewdeprecated
- POSTDisable Whois Privacydeprecated
- POSTEnable Autorenewdeprecated
- POSTEnable Whois Privacydeprecated
- POSTLock Domaindeprecated
- POSTUnlock Domaindeprecated
- GET
Resources
curl --request POST \
--url https://api.dev.name.com/core/v1/domains/{domainName}:setContacts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
}
}
}
'{
"domainName": "example.com",
"createDate": "2023-01-15T14:30:00Z",
"expireDate": "2025-01-15T14:30:00Z",
"autorenewEnabled": true,
"locked": true,
"privacyEnabled": true,
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
}
},
"nameservers": [
"ns1.example.com",
"ns2.example.com"
],
"renewalPrice": 12.99
}Set Contacts
Updates WHOIS contact information for a domain. This includes the registrant, administrative, technical, and billing contacts. All contact objects must be complete — partial updates are not supported. You should fetch the existing contact data first (e.g., via GetDomain and modify only the values you wish to change. This call replaces all four contact sets at once.
Contact Verification
When registrant contact information is updated, validation may be triggered if the new contact information has not been previously validated. This validation is required by ICANN for all TLDs except country-code TLDs (ccTLDs). This validation involves sending an email to the provided address, prompting the recipient to click a link to verify their email address.
curl --request POST \
--url https://api.dev.name.com/core/v1/domains/{domainName}:setContacts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"companyName": "Example Inc.",
"address2": "Suite 400",
"fax": "+15557654321"
}
}
}
'{
"domainName": "example.com",
"createDate": "2023-01-15T14:30:00Z",
"expireDate": "2025-01-15T14:30:00Z",
"autorenewEnabled": true,
"locked": true,
"privacyEnabled": true,
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
}
},
"nameservers": [
"ns1.example.com",
"ns2.example.com"
],
"renewalPrice": 12.99
}Authorizations
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 is the domain name to set the contacts for.
"example.com"
Body
SetContactsRequest passes the contact info for each role to the SetContacts function.
Contacts stores the contact information for the roles related to domains. This schema is used for requests.
Show child attributes
Show child attributes
Contact contains all relevant contact data for a domain registrant. This schema is used for creating and updating contacts (POST/PUT requests) and includes all validation requirements. All fields listed in the required array must be provided and cannot be null or empty.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
1"John"
Last name of the contact. Last name of the contact.
1"Doe"
The first line of the contact's address. The first line of the contact's address.
1"123 Main Street"
City of the contact's address. City of the contact's address.
1"New York"
State or Province of the contact's address. State or Province of the contact's address.
1"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address. This field is required and must be a non-empty string.
1"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The second line of the contact's address (optional).
"Suite 400"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Contact contains all relevant contact data for a domain registrant. This schema is used for creating and updating contacts (POST/PUT requests) and includes all validation requirements. All fields listed in the required array must be provided and cannot be null or empty.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
1"John"
Last name of the contact. Last name of the contact.
1"Doe"
The first line of the contact's address. The first line of the contact's address.
1"123 Main Street"
City of the contact's address. City of the contact's address.
1"New York"
State or Province of the contact's address. State or Province of the contact's address.
1"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address. This field is required and must be a non-empty string.
1"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The second line of the contact's address (optional).
"Suite 400"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Contact contains all relevant contact data for a domain registrant. This schema is used for creating and updating contacts (POST/PUT requests) and includes all validation requirements. All fields listed in the required array must be provided and cannot be null or empty.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
1"John"
Last name of the contact. Last name of the contact.
1"Doe"
The first line of the contact's address. The first line of the contact's address.
1"123 Main Street"
City of the contact's address. City of the contact's address.
1"New York"
State or Province of the contact's address. State or Province of the contact's address.
1"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address. This field is required and must be a non-empty string.
1"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
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).
"Example Inc."
The second line of the contact's address (optional).
"Suite 400"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Contact contains all relevant contact data for a domain registrant. This schema is used for creating and updating contacts (POST/PUT requests) and includes all validation requirements. All fields listed in the required array must be provided and cannot be null or empty.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
1"John"
Last name of the contact. Last name of the contact.
1"Doe"
The first line of the contact's address. The first line of the contact's address.
1"123 Main Street"
City of the contact's address. City of the contact's address.
1"New York"
State or Province of the contact's address. State or Province of the contact's address.
1"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address. This field is required and must be a non-empty string.
1"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The second line of the contact's address (optional).
"Suite 400"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Response
A successful response with updated domain contact information.
The response format for a domain.
The punycode-encoded value of the domain name. The punycode-encoded value of the domain name.
"example.com"
The date and time when the domain was created at the registry. The date and time when the domain was created at the registry.
"2023-01-15T14:30:00Z"
The date and time when the domain will expire. The date and time when the domain will expire.
"2025-01-15T14:30:00Z"
Indicates whether the domain is set to renew automatically before expiration. Indicates whether the domain is set to renew automatically before expiration.
true
Indicates if the domain is locked, preventing transfers to another registrar. Indicates if the domain is locked, preventing transfers to another registrar.
true
Indicates if Whois Privacy is enabled for this domain. Indicates if Whois Privacy is enabled for this domain.
true
Contacts stores the contact information for the roles related to domains. Contacts stores the contact information for the roles related to domains.
Show child attributes
Show child attributes
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. 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.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
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.
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.
true
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. 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.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
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.
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.
true
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. 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.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
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). 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).
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
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.
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.
true
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. 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.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
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.
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.
true
The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers. The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
["ns1.example.com", "ns2.example.com"]The cost to renew the domain. This may be required for the RenewDomain operation. The cost to renew the domain. This may be required for the RenewDomain operation.
12.99
Was this page helpful?