A registered domain is a domain that Wix has registered on behalf of a customer with an external registar.
Domain ID. Identical to domain.
Name of the domain including TLD. Subdomains aren't supported. You can only register a root domain. Domain name and TLD must be separated by a dot. For example, my-new-domain.com. Only alphanumeric characters, hyphens, and dots are supported.
Min: 3 characters Max: 63 characters
ID of the product instance from the Resellers API that belongs to the registeredDomain object. Your account must own a product that supports the chosen TLD, regardless of whether you want to assign the domain to a site or keep it floating. If you want to assign the domain to a site, the relevant site must also own a Premium plan. Contact the Wix B2B team for more information about how to become a reseller and a list of available product IDs.
Date and time the registeredDomain object was created in YYYY-MM-DDThh:mm:ss.sssZ format.
Date and time the registeredDomain object was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.
Revision number, which increments by 1 each time the registered domain is updated. To prevent conflicting changes, the current revision must be passed when updating the registered domain.
Ignored when creating a registered domain.
Information about the Wix site the domain is connected to and whether the domain is assigned as the primary domain or a redirect.
Contact details for the registrant, admin, and tech support of the registered domain. You can read more about which Contact Field Validations are implemented.
Status of the registered domain.
- "UNKNOWN_STATUS": There's no information about the status of the registered domain.
- "PENDING_REGISTRATION": Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
- "ACTIVE": The domain has been registered successfully and is active.
- "FAILED_REGISTRATION": Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the Wix B2B team for more information.
- "CANCELED": The domain has been canceled and isn't active any longer.
ICANN confirmation status.
- "UNKNOWN_ICANN_CONFIRMATION_STATUS": There's no information about the status of the ICANN confirmation process.
- "PENDING": Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
- "CONFIRMED_BY_ALL": The domain has been successfully confirmed by all contacts.
- "EXPIRED": The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the Wix B2B team for more information.
Details about the ICANN confirmation status.
DNS propagation status.
- "UNKNOWN_DNS_PROPAGATION_STATUS": There's no information about the domain's DNS propagation status.
- "IN_PROGRESS": The domain's DNS propagation process has started but hasn't successfully completed yet.
- "COMPLETED": The domain's DNS propagation process has successfully finished.
- "FAILED": The domain's DNS propagation process has failed.
Expiration date of the registered domain in YYYY-MM-DDThh:mm:ss.sssZ format.
ONE OF:
Information about a domain that hasn't been successfully registered yet. Includes the timestamp of the latest registration attempt.
Information about a domain that couldn't be registered. Includes failure code and message.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of up to 100 registered domains.
You must pass the relevant Wix account ID in the header of the call.
The retrieved domains are sorted by createdDate
in descending order.
Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a registeredDomain
object and starts the domain registration process
that may take up to 48 hours to resolve.
You must pass the relevant Wix account ID in the header of the call. You may
also pass a Wix site ID in the header of the call. This assigns the domain to
the site when the registration succeeds. If you don't provide a site ID, the domain
is registered but not assigned to a Wix site. Information about the site is
returned in the siteInfo
object, while information about the account isn't
returned.
To register a domain and assign it to a site, the site must have an active Premium plan. However, if you just want to register a domain without connecting it to a site, the account doesn't need an active Premium plan. In both situations, the account must own a product that supports linking a domain with the chosen TLD. Use Create Package of the Resellers API to add the relevant Premium plan or product to your customer's site. Contact the Wix B2B sales team for details about the available product IDs.
You can register domains for 1, 2, or 3 years, but you don't set the duration
with this endpoint. Instead Wix chooses the registration length based on the
billing cycle of the corresponding productInstance
from the
Resellers API.
The Create Registered Domain call fails if the billing cycle of the relevant
productInstance
isn't 1, 2, or 3 years.
You can only register a root domain. You can't register a subdomain.
If you try to register a domain that isn't available for purchase or there
is already a registeredDomain
object for the specified domain, the call
fails without creating a registeredDomain
object or starting the
registration process.
Wix tries to register the domain several times, but stops if the process fails too often. Contact the Wix B2B team for more information about the number of attempts and their timing.
Wix only checks formal requirements of each field in the contacts
object, such as
the maximum number of characters. Wix doesn't check whether the actual domain registrar has
additional requirements, for example that the postal code is valid in the
specified country. If there is such a mismatch between the request and the
registrar's requirements, the call succeeds but the registration process
can't succeed. Read more about
contact validations.
Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a registered domain.
You must pass the relevant Wix account ID in the header of the call.
Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Redeems a registered domain that's currently in redemption.
You must pass the relevant Wix account ID in the header of the call.
It may take up to 7 days to complete the domain redemption. If the domain
is successfully redeemed, the new expirationDate
is 1 year after the
original expirationDate
.
You can't redeem registered domains that haven't expired yet or have passed the redemption period.
Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.