Skip to content
GitmoapAPIBeta
Reviewmerge-requests
POST/repositories/{repo_id}/merge-requests/{mr_id}/merge

Merge a merge request

merge_mr
  • merge_request:merge
    A token needs the merge_request:merge scope: Merge merge requestsGranted by write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Merges the merge request with the method the repository allows, optionally squashing and deleting the source branch. Every blocking requirement is checked first, and the merge is refused at the first one unmet. A conflict, an impossible fast-forward or a branch that moved since you read it is refused too, and changes nothing.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID
  • mr_idMergeRequestId (integer · int64)Merge request ID

Request body

application/json
  • delete_source_branchboolean or nulloptional
  • merge_methodMergeMethodmerge_commitrebase_mergefast_forwardor nulloptional
  • squashboolean or nulloptional
  • squash_messagestring or nulloptional
Request body exampleSynthesized example
{}

Responses

200Merge request mergedapplication/json
  • created_atstring
  • created_byPrincipalId (string · uuid)The person or agent who opened it.
  • is_draftboolean
  • merge_request_idMergeRequestId (integer · int64)
  • repository_idRepositoryId (string · uuid)
  • source_branchBranchName (string)
  • source_branch_deletedboolean
  • source_branch_headCommitHash (string)
  • statusMergeRequestStatusopenmergedclosed
  • target_branchBranchName (string)
  • target_branch_headCommitHash (string)
  • titleMrTitle (string)
  • updated_atstring
  • author_can_pushboolean or nulloptionalWhether the author can push to the repository — false for a drive-by contributor's merge request. Absent where it was not computed.
  • closed_atstring or nulloptional
  • closed_byPrincipalId (string · uuid) or nulloptional
  • descriptionMrDescription (string) or nulloptional
  • merge_commit_shaCommitHash (string) or nulloptional
  • merged_atstring or nulloptional
  • merged_byPrincipalId (string · uuid) or nulloptional
  • restack_requiredbooleanoptionalPrecise restack signal — set when this MR's downstack was squash-merged (a rebase is genuinely required to drop the duplicated diff). Distinct from the advisory commits_behind. Reset on the MR's next source-advancing write.
  • stack_summaryStackSummary or nulloptionalThe neighbouring merge requests in this stack. Returned when fetching a single merge request, not in listings.
    • The StackSummary schema
    • has_downstackboolean
    • has_upstackboolean
    • downstack_mr_idMergeRequestId (integer · int64) or nulloptional
    • upstack_mr_idsarray of MergeRequestId (integer · int64)optional
  • versioninteger · int64optional0–∞Optimistic-concurrency counter. Bumped on every write; writes condition on the read value.
200 exampleSynthesized example
{
"created_at": "2026-10-16T18:04:05Z",
"created_by": "c9d8e7f6-a5b4-4c3d-9e2f-1a0b9c8d7e6f",
"is_draft": false,
"merge_request_id": 42,
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"source_branch": "feat/run-header-stream",
"source_branch_deleted": false,
"source_branch_head": "0f2fa3185eafd2b72b7e258bbdda4262f9d7b33f",
"status": "open",
"target_branch": "main",
"target_branch_head": "ed021bfd526c0f98077b60b47e232ec231158fc6",
"title": "Label every synthesized example",
"updated_at": "2026-10-16T10:01:42Z",
"author_can_push": false,
"closed_at": "2026-10-14T12:57:39Z",
"closed_by": "b7e2d1c0-9f8e-4d7c-a6b5-c4d3e2f1a0b9",
"description": "Renders each region as density contours of its operations.",
"merge_commit_sha": "c88595725b6e7f4b90330e4ea8f464271f652a91",
"merged_at": "2026-10-12T09:18:20Z",
"merged_by": "c9d8e7f6-a5b4-4c3d-9e2f-1a0b9c8d7e6f",
"restack_required": false,
"stack_summary": {
"has_downstack": false,
"has_upstack": false,
"downstack_mr_id": 42,
"upstack_mr_ids": [
42,
42
]
},
"version": 41
}
400MR not open or source deletedapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-699c",
"message": "Label every synthesized example"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-7aa6",
"message": "Inline scalar newtypes but keep their brand"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-ff3d",
"message": "Stream pipeline status into the run header"
}
}
404Not found — or found and private, which is masked as absentapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-fd90",
"message": "Pin a page's payload to the build that rendered it"
}
}
409The branches conflict: resolve them, in the browser or with git, and merge againapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • MERGE_CONFLICTSThe branches conflict; resolve the conflicts, then merge again
  • PIPELINES_NOT_GREENThe repository requires the merge request's pipelines to pass, and they have not all passed at its head yet; the message says which
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-b6cf",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap mr merge

  • --repo-ididRepository ID (id or owner/repo path)
  • --mr-ididMerge request ID
  • --delete-source-branchflagoptional
  • --merge-methodmerge_commit | rebase_merge | fast_forwardoptional
  • --squashflagoptional
  • --squash-messagestringoptional

Used in these guides