v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Model branches

Merge a branch

Merge a model branch into the shared model.

post/v1/models/{modelId}/branch/{branchName}/merge

Path parameters

modelIdstring uuid required

The unique identifier of the model

branchNamestring required

The name of the branch to merge

Request body

delete_branchboolean

Delete the branch after merging

publish_draftsboolean

When enabled, publish branch-attached drafts when merging

commit_messagestring

Custom commit message for git sync. Defaults to "branch <name> merged via API"

force_override_git_settingsboolean

Requires Connection Admin or Organization Admin permissions. Users with lesser permissions will receive a 403 Forbidden error when attempting to use this parameter.

Allow merge for PR-required or git-follower models. When enabled, the merge will succeed but git will not be synced to avoid force-pushing to main.

Example request

{
  "commit_message": "Merged revenue metrics branch via CI/CD pipeline"
}

Response

Branch merged successfully

successboolean

Whether the merge was successful

published_drafts_countinteger

Number of drafts that were published during the merge

failed_drafts_countinteger

Number of drafts that failed to publish

git_syncedboolean

Whether the changes were synced to git

Example response

{
  "success": true,
  "published_drafts_count": 2,
  "git_synced": true
}