createConnectedDomain( )

Creates a connectedDomain object and starts the domain connection process. It may take up to 48 hours for the DNS changes to take effect.

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.

You can only connect external domains using this endpoint.

You can connect both root domains and subdomains to Wix sites.

The domain can be assigned as a primary domain or a redirect. You can read more about primary and redirected domains. If you connect a domain as "PRIMARY" to a Wix site, the existing primary domain automatically becomes unassigned.

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

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Domains
SCOPE.ACCOUNT.OWNER
Manage Apps in Den Center
Manage Billing
Manage Domains
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
connectedDomainConnectedDomainRequired

Domain to connect.

Returns
Return Type:Promise<ConnectedDomain>
Errors

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

Did this help?