Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Information about the domain to register including contact details.

registeredDomain

RegisteredDomain

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](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683). 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](/packages/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](mailto:bizdev@wix.com) 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](/packages/Introduction). The [Create Registered Domain](/registeredDomains/create-registered-domains) 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](mailto:bizdev@wix.com) 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](https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-validations).

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

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { registeredDomains } from '@wix/domains';

const wixClient = createClient({
  modules: { registeredDomains },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function createRegisteredDomain(registeredDomain) {
  const response = await wixClient.registeredDomains.createRegisteredDomain(registeredDomain);
}

createRegisteredDomain() with Dashboard app access

createRegisteredDomain

registeredDomainId

string

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.

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { registeredDomains } from '@wix/domains';

const wixClient = createClient({
  modules: { registeredDomains },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function getRegisteredDomain(registeredDomainId) {
  const response = await wixClient.registeredDomains.getRegisteredDomain(registeredDomainId);
}

getRegisteredDomain() with Dashboard app access

getRegisteredDomain

options

ListRegisteredDomainsOptions

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.

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { registeredDomains } from '@wix/domains';

const wixClient = createClient({
  modules: { registeredDomains },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listRegisteredDomains(options) {
  const response = await wixClient.registeredDomains.listRegisteredDomains(options);
}

listRegisteredDomains() with Dashboard app access

listRegisteredDomains

ListRegisteredDomainsResponse

ID of the registered domain to redeem. Identical to the domain name
including TLD.

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.

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { registeredDomains } from '@wix/domains';

const wixClient = createClient({
  modules: { registeredDomains },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function redeemRegisteredDomain(registeredDomainId) {
  const response = await wixClient.registeredDomains.redeemRegisteredDomain(registeredDomainId);
}

redeemRegisteredDomain() with Dashboard app access

redeemRegisteredDomain

RedeemRegisteredDomainResponse

#  About the Registered Domains API

The Registered Domains API allows you to register domains through Wix. The
registration process may take up to 48 hours to resolve.

With the Registered Domains API you can:

+ Create registered domains
+ Retrieve registered domains

You can use the [Domain Search API](https://dev.wix.com/docs/sdk/account-level-modules/domains/domain-search/domain-suggestions/suggest-domains)
to check which domains are available for purchase. Learn more about managing
DNS zones with the
[Domain DNS API](https://dev.wix.com/docs/sdk/account-level-modules/domains/domain-dns/introduction).

## Before you begin

It’s important to note the following points before starting to code:

+ The Registered Domains API is accessible via API keys. You can't access this
  API with a standard Auth header. We recommend authenticating calls with an
  API key for your main account instead of using a key for the relevant
  sub-account. But the responses to calls remain consistent across API
  keys, provided you have the necessary permissions.
+ Not all [top-level domains](https://en.wikipedia.org/wiki/Top-level_domain)
  (TLD) can be registered through Wix. Contact the Wix B2B team at
  [bizdev@wix.com](mailto:bizdev@wix.com) for more information.
+ You can only register root domains through Wix. You can't register subdomains.
+ If you want to register a domain to a Wix site, the site must have an active
  [Premium plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683).
  You don't need to have an active Premium plan in case you want to register a
  domain without assigning it to a site. Then, the domain remains floating in
  the account. In both situations, your account must own a `productInstance`
  that supports connecting a domain with the chosen TLD. Use the
  [Resellers API](https://dev.wix.com/docs/sdk/account-level-modules/resellers/packages/create-package-v2)
  to add these products to the site or account before calling
  [Create Registered Domain](https://dev.wix.com/docs/sdk/account-level-modules/domains/registered-domains/create-registered-domain).
+ You can register domains for 1, 2, or 3 years, but you don't set the duration with
  [Create Registered Domain](https://dev.wix.com/docs/sdk/account-level-modules/domains/registered-domains/create-registered-domain).
  Instead Wix chooses the registration length based on the billing cycle of the
  corresponding `productInstance` from the
  [Resellers API](https://dev.wix.com/docs/sdk/account-level-modules/resellers/introduction).
+ Calling Create Registered Domain starts an asynchronous registration process
  that may take up to 48 hours to resolve. There is no webhook that notifies you
  when the process succeeds or fails. You can call
  [Get Registered Domain](https://dev.wix.com/docs/sdk/account-level-modules/domains/registered-domains/get-registered-domain)
  to check the domain's status.
+ When calling Create Registered Domain 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. Read more about
  [contact validations](https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/contact-validations).


## Terminology

+ __Registered domain__: Domain that's purchased, registered, and billed through Wix.
+ __External domain__: Domain that has been purchased through an external provider, not Wix.
  You can use the [Connected Domains API](https://dev.wix.com/docs/sdk/account-level-modules/domains/connected-domains/introduction)
  to connect external domains to Wix sites.
+ __Contact__: For each registered domain you can list 3 different contacts.
  + __Registrant__: Domain owner or contract partner for the domain name. Can be
    an actual person or a company representative.
  + __Admin__: Administrative contact that's listed in the [Whois database](https://www.whois.com/)
    unless the domain includes privacy. Note that not all TLDs can be purchased
    with privacy.
  + __Tech__: Technical support contact.  
+ __DNS propagation__: The process of updating name servers around the world
  that follows every change to your DNS records. It can take up to 48 hours to
  complete. Read more about [DNS propagation](https://support.wix.com/en/article/about-domain-propagation).
+ __Redemption period__: Last chance to keep a domain before it becomes
  publicly available. Learn more about the
  [domain life cycle](https://support.wix.com/en/article/domain-life-cycle).
+ __Reseller__: Strategic partner that offers Wix services to their customers.
  Read more about [resellers](https://dev.wix.com/docs/sdk/account-level-modules/resellers/introduction).
+ __Product instance__: Specific instance of a reseller product. Before you can
  register a domain to a Wix account, the account must own a product that
  supports the chosen domain TLD. Additionally, if you want to
  assign the domain to a site, the site must own a
  [Premium plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683).
  Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for a list of
  available reseller products.
+ __Account__: Wix account that includes access to associated sites.
  + __Team account__: Account type that supports collaborative work by having
    multiple sets of login credentials. This is especially helpful for agencies
    and resellers when managing a large number of customer sites. In Wix Studio
    team accounts are called workspaces. An agency may have multiple workspaces
    in Wix Studio, while in Wix Editor they're limited to a single team account.
  + __Sub-account__: Account that's contained within another account, forming a
    hierarchical structure. The owners of the sub-account are only able to
    interact with sites that belong to the sub-account. This setup is
    particularly useful for agencies and resellers since it limits client access
    to relevant sites only.


To use the RegisteredDomains API, install the `@wix/domains` package using npm or Yarn:
  ```console
npm install @wix/domains
```

or

```console
yarn add @wix/domains
```

Then import `{ registeredDomains }` from `@wix/domains`:

```js
import { registeredDomains } from '@wix/domains'
```
  

domains_registered-domains

AssignmentType

ContactData

Address details, including street name and house number. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Min: 2 characters
Max: 64 characters

address

City. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Min: 2 characters
Max: 64 characters

city

Company name. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Max: 2 characters
Max: 64 characters

company

Country code in
[ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
format. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported. Wix doesn't validate that the postal code is valid for the
given country.

Min: 2 characters
Max: 2 characters

countryCode

Email address.  Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
and a single `@` are supported. Wix doesn't validate that the email address
exists.

Min: 3 characters
Max: 64 characters before the `@` and 63 after

email

First name. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Min: 2 characters
Max: 64 characters

firstName

Last name. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Min: 2 characters
Max: 64 characters

lastName

Phone number. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported. For example, `+15551234567`. Wix doesn't validate that the
phone number belongs to the specified country.

Min: 2 characters
Max: 20 characters

phone

Postal code. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.

Min: 2 characters
Max: 16 characters

postalCode

Subdivision code in
[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
format. Only
[alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
are supported.
__Required__ for these countries:
`”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
`"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
`"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
`"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
`"TW"`, `"UA"`, `"US"`, `”ZA”`.

Min: 2 characters
Max: 2 characters

subdivisionCode

Contacts

Contact information for the domain admin.

admin

Contact information for the domain registrant.

registrant

Contact information for the tech support of the domain.

tech

CursorPaging

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Number of domains to load.

Min: `0`
Max: `100`

limit

number

CursorPagingMetadata

Number of domains returned in the response.

count

cursors

Cursors

Indicates if there are more results after the current page.
If `true`, another page of results can be retrieved.
If `false`, this is the last page.

hasNext

boolean

Cursor pointing to next page in the list of results.

DnsPropagationStatus

Expired

Email addresses of the contacts who haven't confirmed the domain with ICANN
in time.

notConfirmedBy

FailedRegistrationInfo

Failure code.

+ `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
+ `"OTHER"`: There was a failure, but none of the listed failure codes applies.

code

FailureCode

message

ICANNConfirmationStatus

ICANNConfirmationStatusInfo

Details about domains with `"EXPIRED"` ICANN confirmation status.

expired

Details about domains with `"PENDING"` ICANN confirmation status.

pending

LatestAttempt

Number of the latest attempt to register the domain.

Date and time of the latest domain registration attempt in
`YYYY-MM-DDThh:mm:ss.sssZ` format.

timestamp

paging

Metadata about the returned list of registered domains.

pagingMetadata

registeredDomains

Pending

Expiration date of the ICANN confirmation process in
`YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
before this date or the domain won't be active.

expirationDate

Email addresses of the contacts who haven't confirmed the domain with ICANN
yet.

PendingRegistrationInfo

Information about the latest attempt to register
the domain. Wix tries to register the domain several times if the
first attempt is unsuccessful. You can contact the
[Wix B2B team](mailto:bizdev@wix.com)
for more information about the number of attempts and their timing.

latestAttempt

RedirectAssignmentInfo

primaryDomain

Information about a domain that couldn't be registered. Includes
failure code and message.

failedRegistrationInfo

Information about a domain that hasn't been successfully registered
yet. Includes the timestamp of the latest registration attempt.

pendingRegistrationInfo

Date and time the `registeredDomain` object was created in
`YYYY-MM-DDThh:mm:ss.sssZ` format.

_createdDate

Date and time the `registeredDomain` object was last updated in
`YYYY-MM-DDThh:mm:ss.sssZ` format.

_updatedDate

Contact details for the registrant, admin, and tech support of the registered domain.
You can read more about which
[Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
are implemented.

contacts

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.

dnsPropagationStatus

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

domain

Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
format.

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](mailto:bizdev@wix.com) for more information.

icannConfirmationStatus

Details about the ICANN confirmation status.

icannConfirmationStatusInfo

ID of the product instance from the
[Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
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](mailto:bizdev@wix.com)
for more information about how to become a reseller and a list of available
product IDs.

productInstanceId

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.

revision

Information about the Wix site the domain is connected to and whether the
domain is assigned as the primary domain or a redirect.

siteInfo

SiteInfo

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](mailto:bizdev@wix.com) for more information.
+ `"CANCELED"`: The domain has been canceled and isn't active any longer.

status

Status

Extra details if `{"assignmentType": `"REDIRECT"}`.

redirectInfo

ID of the site to which the domain is assigned.

Whether the domain is assigned as the primary domain or a redirect.
Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
__Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
in the request of the Create Registered Domain call.

+ `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
+ `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
+ `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.

redeemRegisteredDomain( )