---
title: "Update pull request"
method: PATCH
path: "/api/repos/{owner}/{repo}/pulls/{pr}"
tags: ["Pull Requests"]
---

# Update pull request

`PATCH /api/repos/{owner}/{repo}/pulls/{pr}`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/pulls/{pr}`
- 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:contents:write`

Update pull request. Requires authenticated authority and enforces current resource policy.

## Path parameters

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

## Request body

- object
  - `expectedVersion` integer, required
  - `title` string
  - `description` string, nullable
  - `targetBranch` string

## Response `200`

Response for status 200

- PullRead
  - `id` string, required
  - `number` integer, required
  - `title` string, required
  - `state` 'open' | 'closed' | 'merged', required
  - `draft` boolean, required
  - `createdAt` string, date-time, required
  - `author` union, required
    - object
      - `kind` 'local', required
      - `actorId` string, required
      - `handle` string, required
      - `displayName` string, nullable, required
      - `avatarUrl` string, nullable, required
      - `bot` true
      - `app` object
        - `listed` boolean, required
      - `via` object
        - `app` string, required
        - `iconUrl` string, nullable, required
    - object
      - `kind` 'github', required
      - `actorId` string, required
      - `authority` 'https://github.com', required
      - `providerId` integer, required
      - `login` string, required
      - `accountType` 'user' | 'organization' | 'bot', required
      - `avatarUrl` string, nullable, required
      - `linkedProfile` object, nullable
        - `actorId` string
        - `handle` string, required
        - `displayName` string, nullable, required
        - `avatarUrl` string, nullable, required
    - object
      - `kind` 'unavailable', required
      - `actorId` string, required
  - `sourceBranch` string, required
  - `targetBranch` string, required
  - `headOid` string, nullable, required
  - `authorActorId` string, required
  - `updatedAt` string, date-time, required
  - `version` integer, required
  - `additions` integer, nullable, required
  - `deletions` integer, nullable, required
  - `changedFiles` integer, nullable, required
  - `description` string, nullable, required
  - `repoId` string, required
  - `sourceRepoId` string, required
  - `sourceRepo` object, nullable, required
    - `owner` string, required
    - `name` string, required
  - `isCrossFork` boolean, required
  - `observedBaseOid` string, nullable, required
  - `mergeSourceOid` string, nullable, required
  - `mergeTargetOidBefore` string, nullable, required
  - `mergeResultOid` string, nullable, required
  - `providerMerge` ProviderMerge
    - `authority` 'https://github.com', required
    - `providerRepositoryId` integer, required
    - `providerNodeId` string, required
    - `number` integer, required
    - `mergedAt` string, date-time, required
    - `mergeCommitOid` string
  - `authorDelegatorActorId` string, required
  - `authorViaInstallationId` string, nullable, required
  - `closedByViaInstallationId` string, nullable, required
  - `mergedByDelegatorActorId` string, required
  - `mergedByViaInstallationId` string, nullable, required
  - `lockedByActorId` string, required
  - `milestoneId` string, nullable, required
  - `closedAt` string, date-time, nullable, required
  - `mergedAt` string, date-time, nullable, required
  - `lockedAt` string, date-time, nullable, required
  - `lockReason` 'off_topic' | 'too_heated' | 'resolved' | 'spam' | 'null', nullable, required
  - `closedByActorId` string, required
  - `closedByDelegatorActorId` string, required
  - `mergedByActorId` string, required
  - `github` object, nullable
    - `url` string, uri, required
    - `number` integer, required
    - `headRepository` object, nullable, required
      - `owner` string, required
      - `name` string, required
    - `state` 'active' | 'paused' | 'needs-attention', required
    - `outboundEnabled` boolean, required
    - `lastImportedAt` string, date-time, required
  - `capabilities` object, required
    - `edit` boolean, required
    - `moderate` boolean, required
    - `review` boolean, required
    - `merge` boolean, required
    - `comment` boolean, required
  - `mergeRoute` 'native' | 'provider' | 'unsupported', required
  - `viewerActorId` string, required

## Other responses

- `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)