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.