checkDomainAvailability( )


Checks whether the given domain is available for purchase.

You can purchase the specified domain in case the returned availability.available boolean is true. The domain is already taken when false is returned.

The domain field must include the TLD. For example, my-new-domain.com.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Domains
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
domainstringRequired

Domain name. Must include the TLD. For example, my-new-domain.com. Only alphanumeric characters, hyphens, and dots are supported.

Min: 3 characters Max: 63 characters

Returns
Return Type:Promise<CheckDomainAvailabilityResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?