Skip to main content
POST
/
projects
/
{project_reference}
/
branches
/
{branchId}
/
merge
Merge Branch
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchId}/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "branch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merged_at": "<string>",
    "merged_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "merged_documents": 123,
  "added_documents": 123,
  "deleted_documents": 123,
  "auto_merged_documents": 123
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

​
project_reference
string
required

Project ID or slug

​
branchId
string<uuid>
required

Branch ID (UUID)

Body

application/json
​
target_branch_id
string<uuid> | null

Target branch ID to merge into (null for main branch)

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