Skip to main content
POST
Merge branch

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

branch_id
string<uuid>
required

Branch UUID belonging to the selected project. Missing or foreign branches return 404.

Body

application/json
expected_version
integer | null

Optional optimistic-concurrency precondition against the persisted source branch version. A stale value returns 412 before merge writes.

Required range: x >= 0
Example:

3

target_branch_id
string<uuid> | null

Target branch ID; omit for main. An unknown target returns not found. Merge eligibility and conflicts are checked again when the merge commits.

merge_message
string

Message stored on the merge audit record.

Example:

"Ship header"

Response

Branch merged successfully.

success
boolean
required
branch
object
required
merged_documents
number
required
added_documents
number
required
deleted_documents
number
required
auto_merged_documents
number
required