Update a pull request - GitHub v3 REST API

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.

curl --location --request PATCH 'https://api.github.com/repos///pulls/' \ --header 'Content-Type: application/json' \ --data-raw '{ "base": "master", "body": "updated body", "state": "open", "title": "new title" }'

{ "_links": { "comments": { "href": "string" }, "commits": { "href": "string" }, "html": { "href": "string" }, "issue": { "href": "string" }, "review_comment": { "href": "string" }, "review_comments": { "href": "string" }, "self": { "href": "string" }, "statuses": { "href": "string" } }, "active_lock_reason": "too heated", "additions": 100, "assignee": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "assignees": [ { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } ], "author_association": "OWNER", "auto_merge": { "commit_message": "string", "commit_title": "string", "enabled_by": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "merge_method": "merge" }, "base": { "label": "string", "ref": "string", "repo": { "allow_forking": true, "allow_merge_commit": true, "allow_rebase_merge": true, "allow_squash_merge": true, "archive_url": "string", "archived": true, "assignees_url": "string", "blobs_url": "string", "branches_url": "string", "clone_url": "string", "collaborators_url": "string", "comments_url": "string", "commits_url": "string", "compare_url": "string", "contents_url": "string", "contributors_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z", "default_branch": "string", "deployments_url": "http://example.com", "description": "string", "disabled": true, "downloads_url": "http://example.com", "events_url": "http://example.com", "fork": true, "forks": 0, "forks_count": 0, "forks_url": "http://example.com", "full_name": "string", "git_commits_url": "string", "git_refs_url": "string", "git_tags_url": "string", "git_url": "string", "has_discussions": true, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": "http://example.com", "hooks_url": "http://example.com", "html_url": "http://example.com", "id": 0, "is_template": true, "issue_comment_url": "string", "issue_events_url": "string", "issues_url": "string", "keys_url": "string", "labels_url": "string", "language": "string", "languages_url": "http://example.com", "license": { "html_url": "http://example.com", "key": "mit", "name": "MIT License", "node_id": "MDc6TGljZW5zZW1pdA==", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit" }, "master_branch": "string", "merges_url": "http://example.com", "milestones_url": "string", "mirror_url": "http://example.com", "name": "string", "node_id": "string", "notifications_url": "string", "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": "http://example.com", "events_url": "string", "followers_url": "http://example.com", "following_url": "string", "gists_url": "string", "gravatar_id": "string", "html_url": "http://example.com", "id": 0, "login": "string", "node_id": "string", "organizations_url": "http://example.com", "received_events_url": "http://example.com", "repos_url": "http://example.com", "site_admin": true, "starred_url": "string", "subscriptions_url": "http://example.com", "type": "string", "url": "http://example.com" }, "permissions": { "admin": true, "maintain": true, "pull": true, "push": true, "triage": true }, "private": true, "pulls_url": "string", "pushed_at": "2019-08-24T14:15:22Z", "releases_url": "string", "size": 0, "ssh_url": "string", "stargazers_count": 0, "stargazers_url": "http://example.com", "statuses_url": "string", "subscribers_url": "http://example.com", "subscription_url": "http://example.com", "svn_url": "http://example.com", "tags_url": "http://example.com", "teams_url": "http://example.com", "temp_clone_token": "string", "topics": [ "string" ], "trees_url": "string", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "visibility": "string", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": true }, "sha": "string", "user": { "avatar_url": "http://example.com", "events_url": "string", "followers_url": "http://example.com", "following_url": "string", "gists_url": "string", "gravatar_id": "string", "html_url": "http://example.com", "id": 0, "login": "string", "node_id": "string", "organizations_url": "http://example.com", "received_events_url": "http://example.com", "repos_url": "http://example.com", "site_admin": true, "starred_url": "string", "subscriptions_url": "http://example.com", "type": "string", "url": "http://example.com" } }, "body": "Please pull these awesome changes", "changed_files": 5, "closed_at": "2011-01-26T19:01:12.000Z", "comments": 10, "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "commits": 3, "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "created_at": "2011-01-26T19:01:12.000Z", "deletions": 3, "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "draft": false, "head": { "label": "string", "ref": "string", "repo": { "allow_forking": true, "allow_merge_commit": true, "allow_rebase_merge": true, "allow_squash_merge": true, "archive_url": "string", "archived": true, "assignees_url": "string", "blobs_url": "string", "branches_url": "string", "clone_url": "string", "collaborators_url": "string", "comments_url": "string", "commits_url": "string", "compare_url": "string", "contents_url": "string", "contributors_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z", "default_branch": "string", "deployments_url": "http://example.com", "description": "string", "disabled": true, "downloads_url": "http://example.com", "events_url": "http://example.com", "fork": true, "forks": 0, "forks_count": 0, "forks_url": "http://example.com", "full_name": "string", "git_commits_url": "string", "git_refs_url": "string", "git_tags_url": "string", "git_url": "string", "has_discussions": true, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": "http://example.com", "hooks_url": "http://example.com", "html_url": "http://example.com", "id": 0, "is_template": true, "issue_comment_url": "string", "issue_events_url": "string", "issues_url": "string", "keys_url": "string", "labels_url": "string", "language": "string", "languages_url": "http://example.com", "license": { "key": "string", "name": "string", "node_id": "string", "spdx_id": "string", "url": "http://example.com" }, "master_branch": "string", "merges_url": "http://example.com", "milestones_url": "string", "mirror_url": "http://example.com", "name": "string", "node_id": "string", "notifications_url": "string", "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": "http://example.com", "events_url": "string", "followers_url": "http://example.com", "following_url": "string", "gists_url": "string", "gravatar_id": "string", "html_url": "http://example.com", "id": 0, "login": "string", "node_id": "string", "organizations_url": "http://example.com", "received_events_url": "http://example.com", "repos_url": "http://example.com", "site_admin": true, "starred_url": "string", "subscriptions_url": "http://example.com", "type": "string", "url": "http://example.com" }, "permissions": { "admin": true, "maintain": true, "pull": true, "push": true, "triage": true }, "private": true, "pulls_url": "string", "pushed_at": "2019-08-24T14:15:22Z", "releases_url": "string", "size": 0, "ssh_url": "string", "stargazers_count": 0, "stargazers_url": "http://example.com", "statuses_url": "string", "subscribers_url": "http://example.com", "subscription_url": "http://example.com", "svn_url": "http://example.com", "tags_url": "http://example.com", "teams_url": "http://example.com", "temp_clone_token": "string", "topics": [ "string" ], "trees_url": "string", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "visibility": "string", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": true }, "sha": "string", "user": { "avatar_url": "http://example.com", "events_url": "string", "followers_url": "http://example.com", "following_url": "string", "gists_url": "string", "gravatar_id": "string", "html_url": "http://example.com", "id": 0, "login": "string", "node_id": "string", "organizations_url": "http://example.com", "received_events_url": "http://example.com", "repos_url": "http://example.com", "site_admin": true, "starred_url": "string", "subscriptions_url": "http://example.com", "type": "string", "url": "http://example.com" } }, "html_url": "https://github.com/octocat/Hello-World/pull/1347", "id": 1, "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "labels": [ { "color": "string", "default": true, "description": "string", "id": 0, "name": "string", "node_id": "string", "url": "string" } ], "locked": true, "maintainer_can_modify": true, "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "mergeable": true, "mergeable_state": "clean", "merged": true, "merged_at": "2011-01-26T19:01:12.000Z", "merged_by": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "milestone": { "closed_at": "2013-02-12T13:22:01.000Z", "closed_issues": 8, "created_at": "2011-04-10T20:09:31.000Z", "creator": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "description": "Tracking milestone for version 1.0", "due_on": "2012-10-09T23:39:01.000Z", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "id": 1002604, "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 42, "open_issues": 4, "state": "open", "title": "v1.0", "updated_at": "2014-03-03T18:58:10.000Z", "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "number": 42, "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", "rebaseable": true, "requested_reviewers": [ { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } ], "requested_teams": [ { "description": "A great team.", "html_url": "https://github.com/orgs/rails/teams/core", "id": 1, "ldap_dn": "uid=example,ou=users,dc=github,dc=com", "members_url": "https://api.github.com/organizations/1/team/1/members{/member}", "name": "Justice League", "node_id": "MDQ6VGVhbTE=", "permission": "admin", "privacy": "closed", "repositories_url": "https://api.github.com/organizations/1/team/1/repos", "slug": "justice-league", "url": "https://api.github.com/organizations/1/team/1" } ], "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "review_comments": 0, "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "state": "open", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "title": "Amazing new feature", "updated_at": "2011-01-26T19:01:12.000Z", "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } }

Request

Path Params

owner

string

required

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

repo

string

required

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

pull_number

integer

required

The number that identifies the pull request.

Body Params application/json

base

string

optional

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.

body

string

optional

The contents of the pull request.

maintainer_can_modify

boolean

optional

Indicates whether maintainers can modify the pull request.

state

enum<string>

optional

State of this Pull Request. Either open or closed.

Allowed values:

openclosed

title

string

optional

The title of the pull request.

Examples

Responses

🟢200Response

application/json

Body

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

_links

object

required

comments

object (Link)

required

Hypermedia Link

commits

object (Link)

required

Hypermedia Link

html

object (Link)

required

Hypermedia Link

issue

object (Link)

required

Hypermedia Link

review_comment

object (Link)

required

Hypermedia Link

review_comments

object (Link)

required

Hypermedia Link

self

object (Link)

required

Hypermedia Link

statuses

object (Link)

required

Hypermedia Link

active_lock_reason

string | null

optional

Example:

too heated

additions

integer

required

Example:

100

assignee

object (Simple User) | null

required

A GitHub user.

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

assignees

array[object (Simple User) {21}] | null

optional

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

author_association

enum<string>

required

How the author is associated with the repository.

Allowed values:

COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:

OWNER

auto_merge

object (Auto merge) | null

required

The status of auto merging a pull request.

commit_message

string

required

Commit message for the merge commit.

commit_title

string

required

Title for the merge commit message.

enabled_by

object (Simple User)

required

A GitHub user.

merge_method

enum<string>

required

The merge method to use.

Allowed values:

mergesquashrebase

base

object

required

label

string

required

ref

string

required

repo

object

required

sha

string

required

user

object

required

body

string | null

required

Example:

Please pull these awesome changes

changed_files

integer

required

Example:

closed_at

string <date-time> | null

required

Example:

2011-01-26T19:01:12.000Z

comments

integer

required

Example:

comments_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/issues/1347/comments

commits

integer

required

Example:

commits_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits

created_at

string <date-time>

required

Example:

2011-01-26T19:01:12.000Z

deletions

integer

required

Example:

diff_url

string <uri>

required

Example:

https://github.com/octocat/Hello-World/pull/1347.diff

draft

boolean

optional

Indicates whether or not the pull request is a draft.

Example:

false

head

object

required

label

string

required

ref

string

required

repo

object | null

required

sha

string

required

user

object

required

html_url

string <uri>

required

Example:

https://github.com/octocat/Hello-World/pull/1347

integer

required

Example:

issue_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/issues/1347

labels

array [object {7}]

required

color

string

required

default

boolean

required

description

string | null

required

integer <int64>

required

name

string

required

node_id

string

required

url

string

required

locked

boolean

required

Example:

true

maintainer_can_modify

boolean

required

Indicates whether maintainers can modify the pull request.

Example:

true

merge_commit_sha

string | null

required

Example:

e5bd3914e2e596debea16f433f57875b5b90bcd6

mergeable

boolean | null

required

Example:

true

mergeable_state

string

required

Example:

clean

merged

boolean

required

merged_at

string <date-time> | null

required

Example:

2011-01-26T19:01:12.000Z

merged_by

object (Simple User) | null

required

A GitHub user.

milestone

object (Milestone) | null

required

A collection of related issues and pull requests.

closed_at

string <date-time> | null

required

Example:

2013-02-12T13:22:01.000Z

closed_issues

integer

required

Example:

created_at

string <date-time>

required

Example:

2011-04-10T20:09:31.000Z

creator

object (Simple User) | null

required

A GitHub user.

description

string | null

required

Example:

Tracking milestone for version 1.0

due_on

string <date-time> | null

required

Example:

2012-10-09T23:39:01.000Z

html_url

string <uri>

required

Example:

https://github.com/octocat/Hello-World/milestones/v1.0

integer

required

Example:

1002604

labels_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/milestones/1/labels

node_id

string

required

Example:

MDk6TWlsZXN0b25lMTAwMjYwNA==

number

integer

required

The number of the milestone.

Example:

open_issues

integer

required

Example:

state

enum<string>

required

The state of the milestone.

Allowed values:

openclosed

Default:

open

Example:

open

title

string

required

The title of the milestone.

Example:

v1.0

updated_at

string <date-time>

required

Example:

2014-03-03T18:58:10.000Z

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/milestones/1

node_id

string

required

Example:

MDExOlB1bGxSZXF1ZXN0MQ==

number

integer

required

Number uniquely identifying the pull request within its repository.

Example:

patch_url

string <uri>

required

Example:

https://github.com/octocat/Hello-World/pull/1347.patch

rebaseable

boolean | null

optional

Example:

true

requested_reviewers

array[object (Simple User) {21}] | null

optional

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

requested_teams

array[object (Team Simple) {12}] | null

optional

description

string | null

required

Description of the team

Example:

A great team.

html_url

string <uri>

required

Example:

https://github.com/orgs/rails/teams/core

integer

required

Unique identifier of the team

Example:

ldap_dn

string

optional

Distinguished Name (DN) that team maps to within LDAP environment

Example:

uid=example,ou=users,dc=github,dc=com

members_url

string

required

Example:

https://api.github.com/organizations/1/team/1/members{/member}

name

string

required

Name of the team

Example:

Justice League

node_id

string

required

Example:

MDQ6VGVhbTE=

permission

string

required

Permission that the team will have for its repositories

Example:

admin

privacy

string

optional

The level of privacy this team should have

Example:

closed

repositories_url

string <uri>

required

Example:

https://api.github.com/organizations/1/team/1/repos

slug

string

required

Example:

justice-league

url

string <uri>

required

URL for the team

Example:

https://api.github.com/organizations/1/team/1

review_comment_url

string

required

Example:

https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}

review_comments

integer

required

Example:

review_comments_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments

state

enum<string>

required

State of this Pull Request. Either open or closed.

Allowed values:

openclosed

Example:

open

statuses_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e

title

string

required

The title of the pull request.

Example:

Amazing new feature

updated_at

string <date-time>

required

Example:

2011-01-26T19:01:12.000Z

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/pulls/1347

user

object (Simple User) | null

required

A GitHub user.

🟠403403

🟠422422