Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.orgstringRequired within parent
bodyobjectRequired within parentAdditional keys: not allowed
body.default_review_effortstringOptionalThe 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Copilot code review settings for an organization — response body

Referenced models: Get Copilot code review settings for an organization — response body

Get Copilot code review settings for an organization — response body
FieldTypePresenceDescription and constraints
$objectRootThe organization's Copilot code review settings.
available_review_effortsarrayRequired within parentThe review efforts that can currently be set for this organization, in display order.
available_review_efforts[]stringEach item
default_review_effortobjectRequired within parentThe 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.configuredJSONRequired within parent
default_review_effort.configured (anyOf 1)stringAlternativeThe 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)nullAlternative
default_review_effort.editablebooleanRequired within parentWhether organization administrators can update the setting.
default_review_effort.effectivestringRequired within parentThe 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_defaultstringRequired within parentThe 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_bystringRequired within parentWhether the enterprise or the organization controls the setting.
Known values: enterprise, organization

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.