createBranch( )

Creates a branch. If a source branch is not provided, the branch will include a blank website.

If a source branch is not provided, the branch will include a blank website.

Important: Align the sourceType field with its corresponding source properties:

  • When sourceType is SOURCE_BRANCH, provide sourceBranchProperties.
  • When sourceType is SOURCE_TEMPLATE, provide sourceTemplateProperties.

Using UNKNOWN_SOURCE_TYPE or mismatched properties results in an ILLEGAL_SOURCE_TYPE error.

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 Site Branches
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
branchBranchRequired

Branch to be created.

Returns
Return Type:Promise<Branch>
Errors
404Not Found

There are 2 errors with this status code.

409Already Exists

There are 2 errors with this status code.

428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?