Branch Object


A branch is a version of draft site content that can be edited independently. Also known as a test site.

Branches let site owners and developers create isolated versions of a site for testing changes without affecting the live site. Each branch maintains its own content, design, and settings while sharing the same site infrastructure.

Learn more about branches.

Properties
createdDatestringRead-onlyformat date-time

Date and time the branch was created.


defaultbooleanRead-only

Whether this branch is the default branch. The default branch is used for API operations when no branch ID is specified.


editorTypeEditorTypeRead-only

Wix editor type.


extendedFieldsExtendedFields

Custom field data for the branch. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Branch ID.


lastPublishDatestringRead-onlyformat int64

Date and time the branch was last published.


namestringmaxLength 50

Branch name.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the branch is updated. To prevent conflicting changes, the current revision must be passed when updating the branch.


One Of

sourceBranchPropertiesSourceBranch

Source branch properties. Use when sourceType = SOURCE_BRANCH.


sourceTemplatePropertiesSourceTemplate

Source template properties. Use when sourceType = SOURCE_TEMPLATE.


sourceTypestring

Source type for this branch's content. Must be aligned with the corresponding source properties below.


tagsPublicTags

Public tags assigned to the branch.


typestring

Branch type.


updatedDatestringRead-onlyformat date-time

Date and time the branch was last updated.

Did this help?