Skip to main content
POST
/
api
/
projects
/
{projectId}
/
branches
/
{branchId}
/
merge
Merge branch
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/branches/{branchId}/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "resolutions": []
}
'
{
  "success": true,
  "requiresApproval": true,
  "message": "<string>",
  "changeRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mergeCommitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "changes": [
    {
      "type": "added",
      "file": "<unknown>",
      "from": "<unknown>",
      "to": "<unknown>"
    }
  ],
  "stats": {
    "filesAdded": 123,
    "filesDeleted": 123,
    "filesModified": 123,
    "totalChanges": 123,
    "filesRenamed": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project ID

branchId
required

Branch ID or "main" for the default branch

Body

application/json
message
string
required

Merge commit message

Minimum string length: 1
resolutions
object[]

Conflict resolutions

Response

200 - application/json

Merge result

Merge result

success
boolean
required

Whether the operation was successful

requiresApproval
boolean
required

Whether approval is required for the merge

message
string
required

Human-readable result message

changeRequestId
string<uuid>

ID of created change request

mergeCommitId
string<uuid>

ID of the merge commit

changes
object[]

List of merged changes

stats
object

Change statistics