createBranch( )

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

Important: The sourceType field must be aligned with the corresponding source properties:

  • When sourceType is SOURCE_BRANCH, you must provide source_branch_properties.
  • When sourceType is SOURCE_TEMPLATE, you must provide source_template_properties.
  • Using UNKNOWN_SOURCE_TYPE or mismatched properties will result in an ILLEGAL_SOURCE_TYPE error.
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?