GitHub: Update Copilot code review settings for an organization
GitHub copilot.copilotUpdateOrganizationCodeReviewSettings: arguments, response, policy and SDK examples.
← Copilot operations · Get started
Operation github.copilot_update_organization_code_review_settings
Provider route: PATCH /orgs/{org}/copilot/code-review/settings. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { GitHubIntegration } from "@alter-ai/github";
async function execute(input: Parameters<GitHubIntegration["copilot"]["copilotUpdateOrganizationCodeReviewSettings"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.copilot.copilotUpdateOrganizationCodeReviewSettings(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_github import GitHubIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.copilot.copilot_update_organization_code_review_settings(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.org | string | Required within parent | |
body | object | Required within parent | Additional keys: not allowed |
body.default_review_effort | string | Optional | The default review effort for repositories that do not choose their own. Use `inherit` to clear the organization’s value. Only efforts listed in the settings’ `available_review_efforts` are accepted, and a rejected effort’s error message lists them. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level). |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Copilot code review settings for an organization — response body |
Referenced models: Get Copilot code review settings for an organization — response body
Schemas
Section titled “Schemas”Get Copilot code review settings for an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The organization's Copilot code review settings. |
available_review_efforts | array | Required within parent | The review efforts that can currently be set for this organization, in display order. |
available_review_efforts[] | string | Each item | |
default_review_effort | object | Required within parent | The default review effort for repositories in the organization that do not choose their own. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level). |
default_review_effort.configured | JSON | Required within parent | |
default_review_effort.configured (anyOf 1) | string | Alternative | The review effort stored for the organization. Null means the organization inherits the default, or has stored a value that is not currently available. |
default_review_effort.configured (anyOf 2) | null | Alternative | |
default_review_effort.editable | boolean | Required within parent | Whether organization administrators can update the setting. |
default_review_effort.effective | string | Required within parent | The review effort that repositories without their own setting use. When that effort is not currently available for the organization, this reports the fallback effort instead. |
default_review_effort.github_default | string | Required within parent | The review effort the organization inherits when it does not configure one. This is the enterprise default when one applies, otherwise GitHub's default. |
default_review_effort.managed_by | string | Required within parent | Whether the enterprise or the organization controls the setting. Known values: enterprise, organization |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: github.copilot_update_organization_code_review_settings. Catalog operation: copilot/update-organization-code-review-settings. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}