name | example | route | scope | type |
---|---|---|---|---|
Update a pull request |
octokit.rest.pulls.update({ owner, repo, pull_number }) |
PATCH /repos/{owner}/{repo}/pulls/{pull_number} |
pulls |
API method |
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
octokit.rest.pulls.update({
owner,
repo,
pull_number,
});
name | required | description |
---|---|---|
owner | yes | |
repo | yes | |
pull_number | yes | |
title | no |
The title of the pull request. |
body | no |
The contents of the pull request. |
state | no |
State of this Pull Request. Either |
base | no |
The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. |
maintainer_can_modify | no |
Indicates whether maintainers can modify the pull request. |
See also: GitHub Developer Guide documentation.