Skip to main content
PATCH
Update org-wide config defaults

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

id
string<uuid>
required

Installation ID (UUID)

Body

application/json
author_exclude
string[]
author_include
string[]
auto_review_enabled
boolean

Default for automatic reviews across the organization. Repositories that have not chosen their own setting follow this.

branch_exclude
string[]
branch_include
string[]
custom_instructions
string
deploy_wait_timeout
integer

Organization default deploy-gated hold in seconds (0 disables it). Repositories that have not chosen their own setting follow this.

Required range: 0 <= x <= 3600
draft_policy
enum<string>

Organization default for how draft PRs are handled. Repositories that have not chosen their own setting follow this.

Available options:
skip,
summary_only,
review
exclude_patterns
string[]

Organization default file patterns to exclude from reviews. Repositories that have not set their own list follow this.

focus
enum<string>
Available options:
security,
performance,
style,
all
gating
enum<string>

Organization default for merge gating. Repositories that have not chosen their own setting follow this.

Available options:
none,
block_on_critical,
block_on_high
high_level_summary
boolean

Organization default for including a high-level summary. Repositories that have not chosen their own setting follow this.

keyword_exclude
string[]
keyword_include
string[]
label_exclude
string[]
label_include
string[]
max_inline_comments
integer
Required range: 1 <= x <= 100
output_format
enum<string>

Organization default for review output format. Repositories that have not chosen their own setting follow this.

Available options:
compact,
table,
checklist
review_output_mode
enum<string>
Available options:
summary_only,
comments_only,
both
reviews_paused
boolean

Pause automatic reviews for the whole organization. While paused, no repository is reviewed automatically, even if it has reviews turned on.

severity_threshold
enum<string>
Available options:
critical,
high,
medium,
low,
info,
all
suggested_changes_enabled
boolean
tone
enum<string>
Available options:
chill,
balanced,
assertive,
roast
verbosity
enum<string>
Available options:
brief,
normal,
detailed

Response

Org-wide config defaults updated

author_exclude
string[]
author_include
string[]
auto_review_enabled
boolean

Default for automatic reviews across the organization. Repositories that have not chosen their own setting follow this.

branch_exclude
string[]
branch_include
string[]
custom_instructions
string
deploy_wait_timeout
integer

Organization default deploy-gated hold in seconds (0 disables it). Repositories that have not chosen their own setting follow this.

Required range: 0 <= x <= 3600
draft_policy
enum<string>

Organization default for how draft PRs are handled. Repositories that have not chosen their own setting follow this.

Available options:
skip,
summary_only,
review
exclude_patterns
string[]

Organization default file patterns to exclude from reviews. Repositories that have not set their own list follow this.

focus
enum<string>
Available options:
security,
performance,
style,
all
gating
enum<string>

Organization default for merge gating. Repositories that have not chosen their own setting follow this.

Available options:
none,
block_on_critical,
block_on_high
high_level_summary
boolean

Organization default for including a high-level summary. Repositories that have not chosen their own setting follow this.

keyword_exclude
string[]
keyword_include
string[]
label_exclude
string[]
label_include
string[]
max_inline_comments
integer
Required range: 1 <= x <= 100
output_format
enum<string>

Organization default for review output format. Repositories that have not chosen their own setting follow this.

Available options:
compact,
table,
checklist
review_output_mode
enum<string>
Available options:
summary_only,
comments_only,
both
reviews_paused
boolean

Pause automatic reviews for the whole organization. While paused, no repository is reviewed automatically, even if it has reviews turned on.

severity_threshold
enum<string>
Available options:
critical,
high,
medium,
low,
info,
all
suggested_changes_enabled
boolean
tone
enum<string>
Available options:
chill,
balanced,
assertive,
roast
verbosity
enum<string>
Available options:
brief,
normal,
detailed