Skip to content
forgit api docs

Remove users from the pull request creation cap bypass list for a repository

DELETE
/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list

Removes users from the pull request creation cap bypass list for a repository. Removed users will be subject to any configured pull request creation cap.

Only users with maintainer permissions can modify the bypass list. You can remove a maximum of 100 users per request.

API method documentation

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Interaction Limits Pull Request Bypass List

A list of user logins to add or remove from the pull request creation cap bypass list.

object
users
required

A list of user logins to add or remove from the bypass list.

Array<string>
Examples
Exampledefault

Example request body

{
  "users": [
    "octocat"
  ]
}

Responses

Section titled “Responses”

204

Section titled “204”

Response

403

Section titled “403”

Forbidden

Media typeapplication/json
Basic Error

Basic Error

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

404

Section titled “404”

Resource not found

Media typeapplication/json
Basic Error

Basic Error

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

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/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
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}