---
title: "Configure GitHub outbound sync"
method: PATCH
path: "/api/repos/{owner}/{repo}/github/outbound"
tags: ["GitHub"]
---

# Configure GitHub outbound sync

`PATCH /api/repos/{owner}/{repo}/github/outbound`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/github/outbound`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token

Updates outbound GitHub synchronization policy for a mirrored repository. Requires authenticated authority and enforces current resource policy.

## Path parameters

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

## Request body

- object
  - `installationId` integer, required
  - `repositoryId` integer, required
  - `expectedVersion` integer, required
  - `mode` 'manual' | 'gc2-leader', required
  - `conflictWinner` 'gitcafe' | 'github'
  - `syncIssues` boolean
  - `syncPullRequests` boolean
  - `syncGit` boolean

## Response `200`

Response for status 200

- object
  - `version` integer, required
  - `mode` 'manual' | 'gc2-leader', 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)