Skip to content

Set fork PR contributor approval permissions for an organization

PUT
/orgs/{org}/actions/permissions/fork-pr-contributor-approval

Sets the fork PR contributor approval policy for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

org
required
string

The organization name. The name is not case sensitive.

Media type application/json
object
approval_policy
required

The policy that controls when fork PR workflows require approval from a maintainer.

string
Allowed values: first_time_contributors_new_to_github first_time_contributors all_external_contributors
Examples
Example default

Set approval policy to first time contributors

{
"approval_policy": "first_time_contributors"
}

Response

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated
{
"message": "example",
"documentation_url": "example",
"errors": [
{
"resource": "example",
"field": "example",
"message": "example",
"code": "example",
"index": 1,
"value": [
"example"
]
}
]
}