About mutations
Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.
For more information, see "Forming calls with GraphQL."
addAssigneesToAssignable
Adds assignees to an assignable object.
Input fields for addAssigneesToAssignable
input(AddAssigneesToAssignableInput!)
Return fields for addAssigneesToAssignable
| Name | Description |
|---|---|
| The item that was assigned. |
| A unique identifier for the client performing the mutation. |
addComment
Adds a comment to an Issue or Pull Request.
Input fields for addComment
input(AddCommentInput!)
Return fields for addComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The edge from the subject's comment connection. |
| The subject. |
| The edge from the subject's timeline connection. |
addDiscussionComment
Adds a comment to a Discussion, possibly as a reply to another comment.
Input fields for addDiscussionComment
input(AddDiscussionCommentInput!)
Return fields for addDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created discussion comment. |
addEnterpriseAdmin
Adds an administrator to the global enterprise account.
Input fields for addEnterpriseAdmin
input(AddEnterpriseAdminInput!)
Return fields for addEnterpriseAdmin
| Name | Description |
|---|---|
| The user who was added as an administrator. |
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| The role of the administrator. |
| The viewer performing the mutation. |
addLabelsToLabelable
Adds labels to a labelable object.
Input fields for addLabelsToLabelable
input(AddLabelsToLabelableInput!)
Return fields for addLabelsToLabelable
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was labeled. |
addProjectCard
Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.
Input fields for addProjectCard
input(AddProjectCardInput!)
Return fields for addProjectCard
| Name | Description |
|---|---|
| The edge from the ProjectColumn's card connection. |
| A unique identifier for the client performing the mutation. |
| The ProjectColumn. |
addProjectColumn
Adds a column to a Project.
Input fields for addProjectColumn
input(AddProjectColumnInput!)
Return fields for addProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The edge from the project's column connection. |
| The project. |
addPullRequestReview
Adds a review to a Pull Request.
Input fields for addPullRequestReview
input(AddPullRequestReviewInput!)
Return fields for addPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created pull request review. |
| The edge from the pull request's review connection. |
addPullRequestReviewComment
Adds a comment to a review.
Input fields for addPullRequestReviewComment
Return fields for addPullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created comment. |
| The edge from the review's comment connection. |
addPullRequestReviewThread
Adds a new thread to a pending Pull Request Review.
Input fields for addPullRequestReviewThread
input(AddPullRequestReviewThreadInput!)
Return fields for addPullRequestReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created thread. |
addReaction
Adds a reaction to a subject.
Input fields for addReaction
input(AddReactionInput!)
Return fields for addReaction
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reactable subject. |
addStar
Adds a star to a Starrable.
Input fields for addStar
input(AddStarInput!)
Return fields for addStar
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
addUpvote
Add an upvote to a discussion or discussion comment.
Input fields for addUpvote
input(AddUpvoteInput!)
Return fields for addUpvote
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The votable subject. |
addVerifiableDomain
Adds a verifiable domain to an owning account.
Input fields for addVerifiableDomain
input(AddVerifiableDomainInput!)
Return fields for addVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was added. |
approveDeployments
Approve all pending deployments under one or more environments.
Input fields for approveDeployments
input(ApproveDeploymentsInput!)
Return fields for approveDeployments
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
approveVerifiableDomain
Approve a verifiable domain for notification delivery.
Input fields for approveVerifiableDomain
input(ApproveVerifiableDomainInput!)
Return fields for approveVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was approved. |
archiveRepository
Marks a repository as archived.
Input fields for archiveRepository
input(ArchiveRepositoryInput!)
Return fields for archiveRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was marked as archived. |
changeUserStatus
Update your status on GitHub.
Input fields for changeUserStatus
input(ChangeUserStatusInput!)
Return fields for changeUserStatus
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Your updated status. |
clearLabelsFromLabelable
Clears all labels from a labelable object.
Input fields for clearLabelsFromLabelable
input(ClearLabelsFromLabelableInput!)
Return fields for clearLabelsFromLabelable
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was unlabeled. |
cloneProject
Creates a new project by cloning configuration from an existing project.
Input fields for cloneProject
input(CloneProjectInput!)
Return fields for cloneProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The id of the JobStatus for populating cloned fields. |
| The new cloned project. |
cloneTemplateRepository
Create a new repository with the same files and directory structure as a template repository.
Input fields for cloneTemplateRepository
input(CloneTemplateRepositoryInput!)
Return fields for cloneTemplateRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
closeIssue
Close an issue.
Input fields for closeIssue
input(CloseIssueInput!)
Return fields for closeIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was closed. |
closePullRequest
Close a pull request.
Input fields for closePullRequest
input(ClosePullRequestInput!)
Return fields for closePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was closed. |
convertProjectCardNoteToIssue
Convert a project note card to one associated with a newly created issue.
Input fields for convertProjectCardNoteToIssue
Return fields for convertProjectCardNoteToIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
convertPullRequestToDraft
Converts a pull request to draft.
Input fields for convertPullRequestToDraft
input(ConvertPullRequestToDraftInput!)
Return fields for convertPullRequestToDraft
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is now a draft. |
createBranchProtectionRule
Create a new branch protection rule.
Input fields for createBranchProtectionRule
input(CreateBranchProtectionRuleInput!)
Return fields for createBranchProtectionRule
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
createCheckRun
Create a check run.
Input fields for createCheckRun
input(CreateCheckRunInput!)
Return fields for createCheckRun
| Name | Description |
|---|---|
| The newly created check run. |
| A unique identifier for the client performing the mutation. |
createCheckSuite
Create a check suite.
Input fields for createCheckSuite
input(CreateCheckSuiteInput!)
Return fields for createCheckSuite
| Name | Description |
|---|---|
| The newly created check suite. |
| A unique identifier for the client performing the mutation. |
createCommitOnBranch
Appends a commit to the given branch as the authenticated user.
This mutation creates a commit whose parent is the HEAD of the provided
branch and also updates that branch to point to the new commit.
It can be thought of as similar to git commit.
Locating a Branch
Commits are appended to a branch of type Ref.
This must refer to a git branch (i.e. the fully qualified path must
begin with refs/heads/, although including this prefix is optional.
Callers may specify the branch to commit to either by its global node
ID or by passing both of repositoryNameWithOwner and refName. For
more details see the documentation for CommittableBranch.
Describing Changes
fileChanges are specified as a FilesChanges object describing
FileAdditions and FileDeletions.
Please see the documentation for FileChanges for more information on
how to use this argument to describe any set of file changes.
Authorship
Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add support for this in the future.
A commit created by a successful execution of this mutation will be authored by the owner of the credential which authenticates the API request. The committer will be identical to that of commits authored using the web interface.
If you need full control over author and committer information, please use the Git Database REST API instead.
Commit Signing
Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface.
Input fields for createCommitOnBranch
input(CreateCommitOnBranchInput!)
Return fields for createCommitOnBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new commit. |
| The ref which has been updated to point to the new commit. |
createDeployment
Creates a new deployment event.
Preview notice
createDeployment is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields for createDeployment
input(CreateDeploymentInput!)
Return fields for createDeployment
| Name | Description |
|---|---|
| True if the default branch has been auto-merged into the deployment ref. |
| A unique identifier for the client performing the mutation. |
| The new deployment. |
createDeploymentStatus
Create a deployment status.
Preview notice
createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields for createDeploymentStatus
input(CreateDeploymentStatusInput!)
Return fields for createDeploymentStatus
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new deployment status. |
createDiscussion
Create a discussion.
Input fields for createDiscussion
input(CreateDiscussionInput!)
Return fields for createDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that was just created. |
createEnterpriseOrganization
Creates an organization as part of an enterprise account.
Input fields for createEnterpriseOrganization
Return fields for createEnterpriseOrganization
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise that owns the created organization. |
| The organization that was created. |
createEnvironment
Creates an environment or simply returns it if already exists.
Input fields for createEnvironment
input(CreateEnvironmentInput!)
Return fields for createEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new or existing environment. |
createIpAllowListEntry
Creates a new IP allow list entry.
Input fields for createIpAllowListEntry
input(CreateIpAllowListEntryInput!)
Return fields for createIpAllowListEntry
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The IP allow list entry that was created. |
createIssue
Creates a new issue.
Input fields for createIssue
input(CreateIssueInput!)
Return fields for createIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new issue. |
createLabel
Creates a new label.
Preview notice
createLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields for createLabel
input(CreateLabelInput!)
Return fields for createLabel
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new label. |
createProject
Creates a new project.
Input fields for createProject
input(CreateProjectInput!)
Return fields for createProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new project. |
createPullRequest
Create a new pull request.
Input fields for createPullRequest
input(CreatePullRequestInput!)
Return fields for createPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new pull request. |
createRef
Create a new Git Ref.
Input fields for createRef
input(CreateRefInput!)
Return fields for createRef
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created ref. |
createRepository
Create a new repository.
Input fields for createRepository
input(CreateRepositoryInput!)
Return fields for createRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
createTeamDiscussion
Creates a new team discussion.
Input fields for createTeamDiscussion
input(CreateTeamDiscussionInput!)
Return fields for createTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new discussion. |
createTeamDiscussionComment
Creates a new team discussion comment.
Input fields for createTeamDiscussionComment
Return fields for createTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new comment. |
deleteBranchProtectionRule
Delete a branch protection rule.
Input fields for deleteBranchProtectionRule
input(DeleteBranchProtectionRuleInput!)
Return fields for deleteBranchProtectionRule
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDeployment
Deletes a deployment.
Input fields for deleteDeployment
input(DeleteDeploymentInput!)
Return fields for deleteDeployment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDiscussion
Delete a discussion and all of its replies.
Input fields for deleteDiscussion
input(DeleteDiscussionInput!)
Return fields for deleteDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that was just deleted. |
deleteDiscussionComment
Delete a discussion comment. If it has replies, wipe it instead.
Input fields for deleteDiscussionComment
input(DeleteDiscussionCommentInput!)
Return fields for deleteDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion comment that was just deleted. |
deleteEnvironment
Deletes an environment.
Input fields for deleteEnvironment
input(DeleteEnvironmentInput!)
Return fields for deleteEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteIpAllowListEntry
Deletes an IP allow list entry.
Input fields for deleteIpAllowListEntry
input(DeleteIpAllowListEntryInput!)
Return fields for deleteIpAllowListEntry
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The IP allow list entry that was deleted. |
deleteIssue
Deletes an Issue object.
Input fields for deleteIssue
input(DeleteIssueInput!)
Return fields for deleteIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository the issue belonged to. |
deleteIssueComment
Deletes an IssueComment object.
Input fields for deleteIssueComment
input(DeleteIssueCommentInput!)
Return fields for deleteIssueComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteLabel
Deletes a label.
Preview notice
deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields for deleteLabel
input(DeleteLabelInput!)
Return fields for deleteLabel
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deletePackageVersion
Delete a package version.
Preview notice
deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.
Input fields for deletePackageVersion
input(DeletePackageVersionInput!)
Return fields for deletePackageVersion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether or not the operation succeeded. |
deleteProject
Deletes a project.
Input fields for deleteProject
input(DeleteProjectInput!)
Return fields for deleteProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository or organization the project was removed from. |
deleteProjectCard
Deletes a project card.
Input fields for deleteProjectCard
input(DeleteProjectCardInput!)
Return fields for deleteProjectCard
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The column the deleted card was in. |
| The deleted card ID. |
deleteProjectColumn
Deletes a project column.
Input fields for deleteProjectColumn
input(DeleteProjectColumnInput!)
Return fields for deleteProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted column ID. |
| The project the deleted column was in. |
deletePullRequestReview
Deletes a pull request review.
Input fields for deletePullRequestReview
input(DeletePullRequestReviewInput!)
Return fields for deletePullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted pull request review. |
deletePullRequestReviewComment
Deletes a pull request review comment.
Input fields for deletePullRequestReviewComment
Return fields for deletePullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request review the deleted comment belonged to. |
deleteRef
Delete a Git Ref.
Input fields for deleteRef
input(DeleteRefInput!)
Return fields for deleteRef
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussion
Deletes a team discussion.
Input fields for deleteTeamDiscussion
input(DeleteTeamDiscussionInput!)
Return fields for deleteTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussionComment
Deletes a team discussion comment.
Input fields for deleteTeamDiscussionComment
Return fields for deleteTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteVerifiableDomain
Deletes a verifiable domain.
Input fields for deleteVerifiableDomain
input(DeleteVerifiableDomainInput!)
Return fields for deleteVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owning account from which the domain was deleted. |
disablePullRequestAutoMerge
Disable auto merge on the given pull request.
Input fields for disablePullRequestAutoMerge
Return fields for disablePullRequestAutoMerge
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request auto merge was disabled on. |
dismissPullRequestReview
Dismisses an approved or rejected pull request review.
Input fields for dismissPullRequestReview
input(DismissPullRequestReviewInput!)
Return fields for dismissPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The dismissed pull request review. |
dismissRepositoryVulnerabilityAlert
Dismisses the Dependabot alert.
Input fields for dismissRepositoryVulnerabilityAlert
Return fields for dismissRepositoryVulnerabilityAlert
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Dependabot alert that was dismissed. |
enablePullRequestAutoMerge
Enable the default auto-merge on a pull request.
Input fields for enablePullRequestAutoMerge
input(EnablePullRequestAutoMergeInput!)
Return fields for enablePullRequestAutoMerge
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request auto-merge was enabled on. |
followUser
Follow a user.
Input fields for followUser
input(FollowUserInput!)
Return fields for followUser
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was followed. |
importProject
Creates a new project by importing columns and a list of issues/PRs.
Preview notice
importProject is available under the Import project preview. During the preview period, the API may change without notice.
Input fields for importProject
input(ImportProjectInput!)
Return fields for importProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new Project!. |
linkRepositoryToProject
Creates a repository link for a project.
Input fields for linkRepositoryToProject
input(LinkRepositoryToProjectInput!)
Return fields for linkRepositoryToProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
lockLockable
Lock a lockable object.
Input fields for lockLockable
input(LockLockableInput!)
Return fields for lockLockable
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The item that was locked. |
markDiscussionCommentAsAnswer
Mark a discussion comment as the chosen answer for discussions in an answerable category.
Input fields for markDiscussionCommentAsAnswer
Return fields for markDiscussionCommentAsAnswer
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that includes the chosen comment. |
markFileAsViewed
Mark a pull request file as viewed.
Input fields for markFileAsViewed
input(MarkFileAsViewedInput!)
Return fields for markFileAsViewed
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Input fields for markPullRequestReadyForReview
Return fields for markPullRequestReadyForReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is ready for review. |
mergeBranch
Merge a head into a branch.
Input fields for mergeBranch
input(MergeBranchInput!)
Return fields for mergeBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The resulting merge Commit. |
mergePullRequest
Merge a pull request.
Input fields for mergePullRequest
input(MergePullRequestInput!)
Return fields for mergePullRequest
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request that was merged. |
minimizeComment
Minimizes a comment on an Issue, Commit, Pull Request, or Gist.
Input fields for minimizeComment
input(MinimizeCommentInput!)
Return fields for minimizeComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The comment that was minimized. |
moveProjectCard
Moves a project card to another place.
Input fields for moveProjectCard
input(MoveProjectCardInput!)
Return fields for moveProjectCard
| Name | Description |
|---|---|
| The new edge of the moved card. |
| A unique identifier for the client performing the mutation. |
moveProjectColumn
Moves a project column to another place.
Input fields for moveProjectColumn
input(MoveProjectColumnInput!)
Return fields for moveProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new edge of the moved column. |
pinIssue
Pin an issue to a repository.
Input fields for pinIssue
input(PinIssueInput!)
Return fields for pinIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was pinned. |
regenerateVerifiableDomainToken
Regenerates a verifiable domain's verification token.
rejectDeployments
Reject all pending deployments under one or more environments.
Input fields for rejectDeployments
input(RejectDeploymentsInput!)
Return fields for rejectDeployments
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
removeAssigneesFromAssignable
Removes assignees from an assignable object.
Input fields for removeAssigneesFromAssignable
Return fields for removeAssigneesFromAssignable
| Name | Description |
|---|---|
| The item that was unassigned. |
| A unique identifier for the client performing the mutation. |
removeEnterpriseAdmin
Removes an administrator from the enterprise.
Input fields for removeEnterpriseAdmin
input(RemoveEnterpriseAdminInput!)
Return fields for removeEnterpriseAdmin
| Name | Description |
|---|---|
| The user who was removed as an administrator. |
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| A message confirming the result of removing an administrator. |
| The viewer performing the mutation. |
removeLabelsFromLabelable
Removes labels from a Labelable object.
Input fields for removeLabelsFromLabelable
input(RemoveLabelsFromLabelableInput!)
Return fields for removeLabelsFromLabelable
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Labelable the labels were removed from. |
removeOutsideCollaborator
Removes outside collaborator from all repositories in an organization.
Input fields for removeOutsideCollaborator
input(RemoveOutsideCollaboratorInput!)
Return fields for removeOutsideCollaborator
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was removed as an outside collaborator. |
removeReaction
Removes a reaction from a subject.
Input fields for removeReaction
input(RemoveReactionInput!)
Return fields for removeReaction
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reactable subject. |
removeStar
Removes a star from a Starrable.
Input fields for removeStar
input(RemoveStarInput!)
Return fields for removeStar
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
removeUpvote
Remove an upvote to a discussion or discussion comment.
Input fields for removeUpvote
input(RemoveUpvoteInput!)
Return fields for removeUpvote
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The votable subject. |
reopenIssue
Reopen a issue.
Input fields for reopenIssue
input(ReopenIssueInput!)
Return fields for reopenIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was opened. |
reopenPullRequest
Reopen a pull request.
Input fields for reopenPullRequest
input(ReopenPullRequestInput!)
Return fields for reopenPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reopened. |
requestReviews
Set review requests on a pull request.
Input fields for requestReviews
input(RequestReviewsInput!)
Return fields for requestReviews
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request that is getting requests. |
| The edge from the pull request to the requested reviewers. |
rerequestCheckSuite
Rerequests an existing check suite.
Input fields for rerequestCheckSuite
input(RerequestCheckSuiteInput!)
Return fields for rerequestCheckSuite
| Name | Description |
|---|---|
| The requested check suite. |
| A unique identifier for the client performing the mutation. |
resolveReviewThread
Marks a review thread as resolved.
Input fields for resolveReviewThread
input(ResolveReviewThreadInput!)
Return fields for resolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
submitPullRequestReview
Submits a pending pull request review.
Input fields for submitPullRequestReview
input(SubmitPullRequestReviewInput!)
Return fields for submitPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The submitted pull request review. |
transferIssue
Transfer an issue to a different repository.
Input fields for transferIssue
input(TransferIssueInput!)
Return fields for transferIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was transferred. |
unarchiveRepository
Unarchives a repository.
Input fields for unarchiveRepository
input(UnarchiveRepositoryInput!)
Return fields for unarchiveRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was unarchived. |
unfollowUser
Unfollow a user.
Input fields for unfollowUser
input(UnfollowUserInput!)
Return fields for unfollowUser
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was unfollowed. |
unlinkRepositoryFromProject
Deletes a repository link from a project.
Input fields for unlinkRepositoryFromProject
Return fields for unlinkRepositoryFromProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
unlockLockable
Unlock a lockable object.
Input fields for unlockLockable
input(UnlockLockableInput!)
Return fields for unlockLockable
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The item that was unlocked. |
unmarkDiscussionCommentAsAnswer
Unmark a discussion comment as the chosen answer for discussions in an answerable category.
Input fields for unmarkDiscussionCommentAsAnswer
Return fields for unmarkDiscussionCommentAsAnswer
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that includes the comment. |
unmarkFileAsViewed
Unmark a pull request file as viewed.
Input fields for unmarkFileAsViewed
input(UnmarkFileAsViewedInput!)
Return fields for unmarkFileAsViewed
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
unmarkIssueAsDuplicate
Unmark an issue as a duplicate of another issue.
Input fields for unmarkIssueAsDuplicate
input(UnmarkIssueAsDuplicateInput!)
Return fields for unmarkIssueAsDuplicate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue or pull request that was marked as a duplicate. |
unminimizeComment
Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.
Input fields for unminimizeComment
input(UnminimizeCommentInput!)
Return fields for unminimizeComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The comment that was unminimized. |
unpinIssue
Unpin a pinned issue from a repository.
Input fields for unpinIssue
input(UnpinIssueInput!)
Return fields for unpinIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was unpinned. |
unresolveReviewThread
Marks a review thread as unresolved.
Input fields for unresolveReviewThread
input(UnresolveReviewThreadInput!)
Return fields for unresolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
updateBranchProtectionRule
Create a new branch protection rule.
Input fields for updateBranchProtectionRule
input(UpdateBranchProtectionRuleInput!)
Return fields for updateBranchProtectionRule
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
updateCheckRun
Update a check run.
Input fields for updateCheckRun
input(UpdateCheckRunInput!)
Return fields for updateCheckRun
| Name | Description |
|---|---|
| The updated check run. |
| A unique identifier for the client performing the mutation. |
updateCheckSuitePreferences
Modifies the settings of an existing check suite.
Input fields for updateCheckSuitePreferences
Return fields for updateCheckSuitePreferences
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateDiscussion
Update a discussion.
Input fields for updateDiscussion
input(UpdateDiscussionInput!)
Return fields for updateDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The modified discussion. |
updateDiscussionComment
Update the contents of a comment on a Discussion.
Input fields for updateDiscussionComment
input(UpdateDiscussionCommentInput!)
Return fields for updateDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The modified discussion comment. |
updateEnterpriseAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an enterprise.
Input fields for updateEnterpriseAllowPrivateRepositoryForkingSetting
Return fields for updateEnterpriseAllowPrivateRepositoryForkingSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated allow private repository forking setting. |
| A message confirming the result of updating the allow private repository forking setting. |
updateEnterpriseDefaultRepositoryPermissionSetting
Sets the base repository permission for organizations in an enterprise.
Input fields for updateEnterpriseDefaultRepositoryPermissionSetting
Return fields for updateEnterpriseDefaultRepositoryPermissionSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated base repository permission setting. |
| A message confirming the result of updating the base repository permission setting. |
updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Sets whether organization members with admin permissions on a repository can change repository visibility.
Input fields for updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Return fields for updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can change repository visibility setting. |
| A message confirming the result of updating the members can change repository visibility setting. |
updateEnterpriseMembersCanCreateRepositoriesSetting
Sets the members can create repositories setting for an enterprise.
Input fields for updateEnterpriseMembersCanCreateRepositoriesSetting
Return fields for updateEnterpriseMembersCanCreateRepositoriesSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can create repositories setting. |
| A message confirming the result of updating the members can create repositories setting. |
updateEnterpriseMembersCanDeleteIssuesSetting
Sets the members can delete issues setting for an enterprise.
Input fields for updateEnterpriseMembersCanDeleteIssuesSetting
Return fields for updateEnterpriseMembersCanDeleteIssuesSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can delete issues setting. |
| A message confirming the result of updating the members can delete issues setting. |
updateEnterpriseMembersCanDeleteRepositoriesSetting
Sets the members can delete repositories setting for an enterprise.
Input fields for updateEnterpriseMembersCanDeleteRepositoriesSetting
Return fields for updateEnterpriseMembersCanDeleteRepositoriesSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can delete repositories setting. |
| A message confirming the result of updating the members can delete repositories setting. |
updateEnterpriseMembersCanInviteCollaboratorsSetting
Sets whether members can invite collaborators are enabled for an enterprise.
Input fields for updateEnterpriseMembersCanInviteCollaboratorsSetting
Return fields for updateEnterpriseMembersCanInviteCollaboratorsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can invite collaborators setting. |
| A message confirming the result of updating the members can invite collaborators setting. |
updateEnterpriseMembersCanMakePurchasesSetting
Sets whether or not an organization admin can make purchases.
Input fields for updateEnterpriseMembersCanMakePurchasesSetting
Return fields for updateEnterpriseMembersCanMakePurchasesSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can make purchases setting. |
| A message confirming the result of updating the members can make purchases setting. |
updateEnterpriseMembersCanUpdateProtectedBranchesSetting
Sets the members can update protected branches setting for an enterprise.
Input fields for updateEnterpriseMembersCanUpdateProtectedBranchesSetting
Return fields for updateEnterpriseMembersCanUpdateProtectedBranchesSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can update protected branches setting. |
| A message confirming the result of updating the members can update protected branches setting. |
updateEnterpriseMembersCanViewDependencyInsightsSetting
Sets the members can view dependency insights for an enterprise.
Input fields for updateEnterpriseMembersCanViewDependencyInsightsSetting
Return fields for updateEnterpriseMembersCanViewDependencyInsightsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can view dependency insights setting. |
| A message confirming the result of updating the members can view dependency insights setting. |
updateEnterpriseOrganizationProjectsSetting
Sets whether organization projects are enabled for an enterprise.
Input fields for updateEnterpriseOrganizationProjectsSetting
Return fields for updateEnterpriseOrganizationProjectsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated organization projects setting. |
| A message confirming the result of updating the organization projects setting. |
updateEnterpriseProfile
Updates an enterprise's profile.
Input fields for updateEnterpriseProfile
input(UpdateEnterpriseProfileInput!)
Return fields for updateEnterpriseProfile
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
updateEnterpriseRepositoryProjectsSetting
Sets whether repository projects are enabled for a enterprise.
Input fields for updateEnterpriseRepositoryProjectsSetting
Return fields for updateEnterpriseRepositoryProjectsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated repository projects setting. |
| A message confirming the result of updating the repository projects setting. |
updateEnterpriseTeamDiscussionsSetting
Sets whether team discussions are enabled for an enterprise.
Input fields for updateEnterpriseTeamDiscussionsSetting
Return fields for updateEnterpriseTeamDiscussionsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated team discussions setting. |
| A message confirming the result of updating the team discussions setting. |
updateEnterpriseTwoFactorAuthenticationRequiredSetting
Sets whether two factor authentication is required for all users in an enterprise.
Input fields for updateEnterpriseTwoFactorAuthenticationRequiredSetting
Return fields for updateEnterpriseTwoFactorAuthenticationRequiredSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated two factor authentication required setting. |
| A message confirming the result of updating the two factor authentication required setting. |
updateEnvironment
Updates an environment.
Input fields for updateEnvironment
input(UpdateEnvironmentInput!)
Return fields for updateEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated environment. |
updateIpAllowListEnabledSetting
Sets whether an IP allow list is enabled on an owner.
Input fields for updateIpAllowListEnabledSetting
Return fields for updateIpAllowListEnabledSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The IP allow list owner on which the setting was updated. |
updateIpAllowListEntry
Updates an IP allow list entry.
Input fields for updateIpAllowListEntry
input(UpdateIpAllowListEntryInput!)
Return fields for updateIpAllowListEntry
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The IP allow list entry that was updated. |
updateIpAllowListForInstalledAppsEnabledSetting
Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.
Input fields for updateIpAllowListForInstalledAppsEnabledSetting
Return fields for updateIpAllowListForInstalledAppsEnabledSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The IP allow list owner on which the setting was updated. |
updateIssue
Updates an Issue.
Input fields for updateIssue
input(UpdateIssueInput!)
Return fields for updateIssue
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The issue. |
updateIssueComment
Updates an IssueComment object.
Input fields for updateIssueComment
input(UpdateIssueCommentInput!)
Return fields for updateIssueComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateLabel
Updates an existing label.
Preview notice
updateLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields for updateLabel
input(UpdateLabelInput!)
Return fields for updateLabel
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated label. |
updateNotificationRestrictionSetting
Update the setting to restrict notifications to only verified or approved domains available to an owner.
Input fields for updateNotificationRestrictionSetting
Return fields for updateNotificationRestrictionSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owner on which the setting was updated. |
updateOrganizationAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an organization.
Input fields for updateOrganizationAllowPrivateRepositoryForkingSetting
Return fields for updateOrganizationAllowPrivateRepositoryForkingSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A message confirming the result of updating the allow private repository forking setting. |
| The organization with the updated allow private repository forking setting. |
updateProject
Updates an existing project.
Input fields for updateProject
input(UpdateProjectInput!)
Return fields for updateProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project. |
updateProjectCard
Updates an existing project card.
Input fields for updateProjectCard
input(UpdateProjectCardInput!)
Return fields for updateProjectCard
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
updateProjectColumn
Updates an existing project column.
Input fields for updateProjectColumn
input(UpdateProjectColumnInput!)
Return fields for updateProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project column. |
updatePullRequest
Update a pull request.
Input fields for updatePullRequest
input(UpdatePullRequestInput!)
Return fields for updatePullRequest
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestBranch
Merge HEAD from upstream branch into pull request branch.
Input fields for updatePullRequestBranch
input(UpdatePullRequestBranchInput!)
Return fields for updatePullRequestBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestReview
Updates the body of a pull request review.
Input fields for updatePullRequestReview
input(UpdatePullRequestReviewInput!)
Return fields for updatePullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request review. |
updatePullRequestReviewComment
Updates a pull request review comment.
Input fields for updatePullRequestReviewComment
Return fields for updatePullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateRef
Update a Git Ref.
Input fields for updateRef
input(UpdateRefInput!)
Return fields for updateRef
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated Ref. |
updateRefs
Creates, updates and/or deletes multiple refs in a repository.
This mutation takes a list of RefUpdates and performs these updates
on the repository. All updates are performed atomically, meaning that
if one of them is rejected, no other ref will be modified.
RefUpdate.beforeOid specifies that the given reference needs to point
to the given value before performing any updates. A value of
0000000000000000000000000000000000000000 can be used to verify that
the references should not exist.
RefUpdate.afterOid specifies the value that the given reference
will point to after performing all updates. A value of
0000000000000000000000000000000000000000 can be used to delete a
reference.
If RefUpdate.force is set to true, a non-fast-forward updates
for the given reference will be allowed.
Preview notice
updateRefs is available under the Update refs preview update multiple refs in a single operation preview. During the preview period, the API may change without notice.
Input fields for updateRefs
input(UpdateRefsInput!)
Return fields for updateRefs
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
updateRepository
Update information about a repository.
Input fields for updateRepository
input(UpdateRepositoryInput!)
Return fields for updateRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateSubscription
Updates the state for subscribable subjects.
Input fields for updateSubscription
input(UpdateSubscriptionInput!)
Return fields for updateSubscription
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The input subscribable entity. |
updateTeamDiscussion
Updates a team discussion.
Input fields for updateTeamDiscussion
input(UpdateTeamDiscussionInput!)
Return fields for updateTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated discussion. |
updateTeamDiscussionComment
Updates a discussion comment.
Input fields for updateTeamDiscussionComment
Return fields for updateTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateTeamReviewAssignment
Updates team review assignment.
Preview notice
updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.
Input fields for updateTeamReviewAssignment
input(UpdateTeamReviewAssignmentInput!)
Return fields for updateTeamReviewAssignment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team that was modified. |
updateTopics
Replaces the repository's topics with the given topics.
Input fields for updateTopics
input(UpdateTopicsInput!)
Return fields for updateTopics
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Names of the provided topics that are not valid. |
| The updated repository. |
verifyVerifiableDomain
Verify that a verifiable domain has the expected DNS record.
Input fields for verifyVerifiableDomain
input(VerifyVerifiableDomainInput!)
Return fields for verifyVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was verified. |