Merge branch

mergeBranch(input: MergeBranchInput!): MergeBranchPayload!

Requires project.files.write.

Arguments

ArgumentTypeRequired
inputMergeBranchInput!Yes

Input fields

input

MergeBranchInput

FieldTypeRequiredDescription
branchIdID!Yes
targetBranchIdIDNoTarget branch ID; omit for main. An unknown target returns not found. Merge eligibility and conflicts are checked again when the merge commits.
expectedVersionIntNo
mergeMessageStringNoMessage stored on the merge audit record. Null and omission store none.

Response

Returns MergeBranchPayload!. Open the type for its fields and nested types.

FieldType
branchBranch!
mergedDocumentsInt!
addedDocumentsInt!
deletedDocumentsInt!
autoMergedDocumentsInt!
auditIdID!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation MergeBranch($input: MergeBranchInput!) {
  mergeBranch(input: $input) {
    addedDocuments
    auditId
    autoMergedDocuments
    deletedDocuments
    mergedDocuments
  }
}
json
{
  "input": {
    "branchId": "00000000-0000-4000-8000-000000000001"
  }
}