About the Wix Branches API

The Wix Branches API enables you to create and manage branches within a Wix site. A branch is a version of draft site content that can be edited independently of the published site, that is also known as a test site.

With the Wix Branches API, you can:

• Create and manage branches to facilitate version control and collaborative development.
• Retrieve and update branch details to keep site content organized and up-to-date.
• Query and filter branches to efficiently manage multiple versions.

Before you begin

• This API allows you to manage branch metadata only; editing the branch itself is possible only in the editor.

• Note that when a new site is created, a branch is created by default - this is the ORIGINAL_BRANCH of the site.

Use cases

• Create a branch and redirect a Wix user for editing

Branch types

The following branch types are supported:

• ORIGINAL_BRANCH: The branch created when the site was created.
• USER: A branch created by a Wix user.
• TECHNICAL: A branch created for technical purposes that are unrelated to a Wix user's actions. TECHNICAL branches are deleted 30 days after creation.
• MOBILE_APP: The branch created for the mobile version of the site.

Terminology

• Branch: A version of draft site content that can be edited independently of the published site. Also known as a test site.
• Source Branch: The original branch from which a new branch is created.