Branch Object


A branch is a version of draft site content that can be edited independently. Also known as a test site. Read more about branches in this article.

Properties
idstringRead-onlyformat GUID

Branch ID.


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.


typestring

Branch type.


namestringmaxLength 50

Branch name.


sourceTypestring

Source type. Must be aligned with the corresponding source properties below.


lastPublishDatestringRead-onlyformat int64

Date and time the branch was last published, if relevant.


editorTypeEditorTypeRead-only

Wix editor type.


defaultbooleanRead-only

Whether this branch is the default.


createdDatestringRead-onlyformat date-time

Date and time the branch was created.


updatedDatestringRead-onlyformat date-time

Date and time the branch was last updated.


extendedFieldsExtendedFields

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


One Of

sourceBranchPropertiesSourceBranchProperties

Source branch properties. Use when sourceType = SOURCE_BRANCH.


sourceTemplatePropertiesSourceTemplateProperties

Source template properties. Use when sourceType = SOURCE_TEMPLATE.

Did this help?