---
title: "Merge a pull request"
method: POST
path: "/api/repos/{owner}/{repo}/pulls/{pr}/merge"
tags: ["Pull Requests"]
---

# Merge a pull request

`POST /api/repos/{owner}/{repo}/pulls/{pr}/merge`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/pulls/{pr}/merge`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `pr:merge:write`

Merge a pull request. Requires authenticated authority and enforces current resource policy.

## Path parameters

- `owner` string, required
- `repo` string, required
- `pr` string, required

## Request body

- object
  - `requestId` string, required
  - `expectedVersion` integer, required
  - `headOid` string, required
  - `baseOid` string, required
  - `strategy` 'fast-forward' | 'merge' | 'squash' | 'rebase', required

## Response `200`

Response for status 200

- MergeOutcome
  - `id` union, required
    - string
    - string
  - `state` 'accepted' | 'completed' | 'failed', required
  - `resultOid` string
  - `reason` 'rejected' | 'merge-precondition-changed' | 'native-conflict' | 'native-failure' | 'native-cancelled' | 'reconciliation-required' | 'already-up-to-date'
  - `waiting` object
    - `reason` 'provider-admission-required' | 'provider-authority-required', required
    - `jobKind` string, nullable, required
    - `jobId` string, nullable, required
  - `providerRefusal` object
    - `status` 405 | 409 | 422, required
    - `message` string
    - `requestId` string
  - `providerFailure` object
    - `code` string, required
    - `message` string
  - `failure` 'conflict' | 'precondition-changed' | 'too-large' | 'lfs-unsupported' | 'remote-rejected' | 'cancelled' | 'retry-later' | 'internal'
  - `attempts` integer

## Other responses

- `202`: Response for status 202
- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)