Set fork PR contributor approval permissions for an organization

1 parameter · 1 body field

orgstringrequired

The organization name. The name is not case sensitive.

approval_policystringrequired

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

Allowed:first_time_contributors_new_to_githubfirst_time_contributorsall_external_contributors

3 status codes

204Response

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.forkPrContributorApproval.update({
  org: "acme-inc",
  approvalPolicy: "example",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors