Pull Requests

Push scopes and other per-pull-request data to Mergify.

Set the scopes for a pull request

POST /repos/{owner}/{repository}/pulls/{number}/scopes
Authorization (any one of)
Application Key GitHub Token
Path Parameters
number integer required
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

repository string required

The name of the repository

min length: 1 · pattern: ^[\w\-\.]+$

Request Body
scopesstring[]required
Responses
204 Successful Response
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request 
curl -X POST "https://api.mergify.com/v1/repos/:owner/:repository/pulls/:number/scopes" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "scopes": [
    "string"
  ]
}'

Was this page helpful?