Skip to main content

The mutation type defines GraphQL operations that change data on the server.

In this article

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."

abortQueuedMigrations

Clear all of a customer's queued migrations.

Input fields for abortQueuedMigrations

Return fields for abortQueuedMigrations

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

abortRepositoryMigration

Abort a repository migration queued or in progress.

Input fields for abortRepositoryMigration

Return fields for abortRepositoryMigration

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

acceptEnterpriseAdministratorInvitation

Accepts a pending invitation for a user to become an administrator of an enterprise.

Input fields for acceptEnterpriseAdministratorInvitation

Return fields for acceptEnterpriseAdministratorInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was accepted.

message (String)

A message confirming the result of accepting an administrator invitation.

acceptTopicSuggestion

Applies a suggested topic to the repository.

Input fields for acceptTopicSuggestion

Return fields for acceptTopicSuggestion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The accepted topic.

Warning

topic is deprecated.

Suggested topics are no longer supported Removal on 2024-04-01 UTC.

addAssigneesToAssignable

Adds assignees to an assignable object.

Input fields for addAssigneesToAssignable

Return fields for addAssigneesToAssignable

NameDescription

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

addComment

Adds a comment to an Issue or Pull Request.

Input fields for addComment

Return fields for addComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentEdge (IssueCommentEdge)

The edge from the subject's comment connection.

subject (Node)

The subject.

timelineEdge (IssueTimelineItemEdge)

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

Return fields for addDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The newly created discussion comment.

addDiscussionPollVote

Vote for an option in a discussion poll.

Input fields for addDiscussionPollVote

Return fields for addDiscussionPollVote

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOption (DiscussionPollOption)

The poll option that a vote was added to.

addEnterpriseOrganizationMember

Adds enterprise members to an organization within the enterprise.

Input fields for addEnterpriseOrganizationMember

Return fields for addEnterpriseOrganizationMember

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

users ([User!])

The users who were added to the organization.

addEnterpriseSupportEntitlement

Adds a support entitlement to an enterprise member.

Input fields for addEnterpriseSupportEntitlement

Return fields for addEnterpriseSupportEntitlement

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of adding the support entitlement.

addLabelsToLabelable

Adds labels to a labelable object.

Input fields for addLabelsToLabelable

Return fields for addLabelsToLabelable

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

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

Return fields for addProjectCard

NameDescription

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.

addProjectColumn

Adds a column to a Project.

Input fields for addProjectColumn

Return fields for addProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.

addProjectV2DraftIssue

Creates a new draft issue and add it to a Project.

Input fields for addProjectV2DraftIssue

Return fields for addProjectV2DraftIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectItem (ProjectV2Item)

The draft issue added to the project.

addProjectV2ItemById

Links an existing content instance to a Project.

Input fields for addProjectV2ItemById

Return fields for addProjectV2ItemById

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item added to the project.

addPullRequestReview

Adds a review to a Pull Request.

Input fields for addPullRequestReview

Return fields for addPullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The newly created pull request review.

reviewEdge (PullRequestReviewEdge)

The edge from the pull request's review connection.

addPullRequestReviewComment

Adds a comment to a review.

Input fields for addPullRequestReviewComment

Return fields for addPullRequestReviewComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created comment.

commentEdge (PullRequestReviewCommentEdge)

The edge from the review's comment connection.

addPullRequestReviewThread

Adds a new thread to a pending Pull Request Review.

Input fields for addPullRequestReviewThread

Return fields for addPullRequestReviewThread

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.

addPullRequestReviewThreadReply

Adds a reply to an existing Pull Request Review Thread.

Input fields for addPullRequestReviewThreadReply

Return fields for addPullRequestReviewThreadReply

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created reply.

addReaction

Adds a reaction to a subject.

Input fields for addReaction

Return fields for addReaction

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

addStar

Adds a star to a Starrable.

Input fields for addStar

Return fields for addStar

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

addUpvote

Add an upvote to a discussion or discussion comment.

Input fields for addUpvote

Return fields for addUpvote

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

addVerifiableDomain

Adds a verifiable domain to an owning account.

Input fields for addVerifiableDomain

Return fields for addVerifiableDomain

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was added.

approveDeployments

Approve all pending deployments under one or more environments.

Input fields for approveDeployments

Return fields for approveDeployments

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

approveVerifiableDomain

Approve a verifiable domain for notification delivery.

Input fields for approveVerifiableDomain

Return fields for approveVerifiableDomain

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was approved.

archiveProjectV2Item

Archives a ProjectV2Item.

Input fields for archiveProjectV2Item

Return fields for archiveProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item archived from the project.

archiveRepository

Marks a repository as archived.

Input fields for archiveRepository

Return fields for archiveRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was marked as archived.

cancelEnterpriseAdminInvitation

Cancels a pending invitation for an administrator to join an enterprise.

Input fields for cancelEnterpriseAdminInvitation

Return fields for cancelEnterpriseAdminInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was canceled.

message (String)

A message confirming the result of canceling an administrator invitation.

cancelSponsorship

Cancel an active sponsorship.

Input fields for cancelSponsorship

Return fields for cancelSponsorship

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was being used at the time of cancellation.

changeUserStatus

Update your status on GitHub.

Input fields for changeUserStatus

Return fields for changeUserStatus

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

clearLabelsFromLabelable

Clears all labels from a labelable object.

Input fields for clearLabelsFromLabelable

Return fields for clearLabelsFromLabelable

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.

clearProjectV2ItemFieldValue

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, iteration and milestone fields are supported.

Input fields for clearProjectV2ItemFieldValue

Return fields for clearProjectV2ItemFieldValue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

cloneProject

Creates a new project by cloning configuration from an existing project.

Input fields for cloneProject

Return fields for cloneProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.

cloneTemplateRepository

Create a new repository with the same files and directory structure as a template repository.

Input fields for cloneTemplateRepository

Return fields for cloneTemplateRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

closeDiscussion

Close a discussion.

Input fields for closeDiscussion

Return fields for closeDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was closed.

closeIssue

Close an issue.

Input fields for closeIssue

Return fields for closeIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.

closePullRequest

Close a pull request.

Input fields for closePullRequest

Return fields for closePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

convertPullRequestToDraft

Converts a pull request to draft.

Input fields for convertPullRequestToDraft

Return fields for convertPullRequestToDraft

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is now a draft.

copyProjectV2

Copy a project.

Input fields for copyProjectV2

Return fields for copyProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The copied project.

createAttributionInvitation

Invites a user to claim reattributable data.

Input fields for createAttributionInvitation

Return fields for createAttributionInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (Organization)

The owner scoping the reattributable data.

source (Claimable)

The account owning the data to reattribute.

target (Claimable)

The account which may claim the data.

createBranchProtectionRule

Create a new branch protection rule.

Input fields for createBranchProtectionRule

Return fields for createBranchProtectionRule

NameDescription

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckRun

Create a check run.

Input fields for createCheckRun

Return fields for createCheckRun

NameDescription

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Create a check suite.

Input fields for createCheckSuite

Return fields for createCheckSuite

NameDescription

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

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

Return fields for createCommitOnBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

commit (Commit)

The new commit.

ref (Ref)

The ref which has been updated to point to the new commit.

createDeployment

Creates a new deployment event.

Note

createDeployment is available under the Deployments preview. During the preview period, the API may change without notice.

Input fields for createDeployment

Return fields for createDeployment

NameDescription

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.

createDeploymentStatus

Create a deployment status.

Note

createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.

Input fields for createDeploymentStatus

Return fields for createDeploymentStatus

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createDiscussion

Create a discussion.

Input fields for createDiscussion

Return fields for createDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just created.

createEnterpriseOrganization

Creates an organization as part of an enterprise account. A personal access token used to create an organization is implicitly permitted to update the organization it created, if the organization is part of an enterprise that has SAML enabled or uses Enterprise Managed Users. If the organization is not part of such an enterprise, and instead has SAML enabled for it individually, the token will then require SAML authorization to continue working against that organization.

Input fields for createEnterpriseOrganization

Return fields for createEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise that owns the created organization.

organization (Organization)

The organization that was created.

createEnvironment

Creates an environment or simply returns it if already exists.

Input fields for createEnvironment

Return fields for createEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The new or existing environment.

createIpAllowListEntry

Creates a new IP allow list entry.

Input fields for createIpAllowListEntry

Return fields for createIpAllowListEntry

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was created.

createIssue

Creates a new issue.

Input fields for createIssue

Return fields for createIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.

createLabel

Creates a new label.

Note

createLabel is available under the Labels preview. During the preview period, the API may change without notice.

Input fields for createLabel

Return fields for createLabel

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createLinkedBranch

Create a branch linked to an issue.

Input fields for createLinkedBranch

Return fields for createLinkedBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was linked to.

linkedBranch (LinkedBranch)

The new branch issue reference.

createMigrationSource

Creates a GitHub Enterprise Importer (GEI) migration source.

Input fields for createMigrationSource

Return fields for createMigrationSource

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationSource (MigrationSource)

The created migration source.

createProject

Creates a new project.

Input fields for createProject

Return fields for createProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

createProjectV2

Creates a new project.

Input fields for createProjectV2

Return fields for createProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The new project.

createProjectV2Field

Create a new project field.

Input fields for createProjectV2Field

Return fields for createProjectV2Field

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createPullRequest

Create a new pull request.

Input fields for createPullRequest

Return fields for createPullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

createRef

Create a new Git Ref.

Input fields for createRef

Return fields for createRef

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.

createRepository

Create a new repository.

Input fields for createRepository

Return fields for createRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

createRepositoryRuleset

Create a repository ruleset.

Input fields for createRepositoryRuleset

Return fields for createRepositoryRuleset

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ruleset (RepositoryRuleset)

The newly created Ruleset.

createSponsorsListing

Create a GitHub Sponsors profile to allow others to sponsor you or your organization.

Input fields for createSponsorsListing

Return fields for createSponsorsListing

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsListing (SponsorsListing)

The new GitHub Sponsors profile.

createSponsorsTier

Create a new payment tier for your GitHub Sponsors profile.

Input fields for createSponsorsTier

Return fields for createSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The new tier.

createSponsorship

Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.

Input fields for createSponsorship

Return fields for createSponsorship

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was started.

createSponsorships

Make many one-time sponsorships for different sponsorable users or organizations at once. Can only sponsor those who have a public GitHub Sponsors profile.

Input fields for createSponsorships

Return fields for createSponsorships

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorables ([Sponsorable!])

The users and organizations who received a sponsorship.

createTeamDiscussion

Creates a new team discussion.

Input fields for createTeamDiscussion

Return fields for createTeamDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.

Warning

teamDiscussion is deprecated.

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

createTeamDiscussionComment

Creates a new team discussion comment.

Input fields for createTeamDiscussionComment

Return fields for createTeamDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.

Warning

teamDiscussionComment is deprecated.

The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.

createUserList

Creates a new user list.

Input fields for createUserList

Return fields for createUserList

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

list (UserList)

The list that was just created.

viewer (User)

The user who created the list.

declineTopicSuggestion

Rejects a suggested topic for the repository.

Input fields for declineTopicSuggestion

Return fields for declineTopicSuggestion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The declined topic.

Warning

topic is deprecated.

Suggested topics are no longer supported Removal on 2024-04-01 UTC.

deleteBranchProtectionRule

Delete a branch protection rule.

Input fields for deleteBranchProtectionRule

Return fields for deleteBranchProtectionRule

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDeployment

Deletes a deployment.

Input fields for deleteDeployment

Return fields for deleteDeployment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDiscussion

Delete a discussion and all of its replies.

Input fields for deleteDiscussion

Return fields for deleteDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just deleted.

deleteDiscussionComment

Delete a discussion comment. If it has replies, wipe it instead.

Input fields for deleteDiscussionComment

Return fields for deleteDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.

deleteEnvironment

Deletes an environment.

Input fields for deleteEnvironment

Return fields for deleteEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIpAllowListEntry

Deletes an IP allow list entry.

Input fields for deleteIpAllowListEntry

Return fields for deleteIpAllowListEntry

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was deleted.

deleteIssue

Deletes an Issue object.

Input fields for deleteIssue

Return fields for deleteIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.

deleteIssueComment

Deletes an IssueComment object.

Input fields for deleteIssueComment

Return fields for deleteIssueComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLabel

Deletes a label.

Note

deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.

Input fields for deleteLabel

Return fields for deleteLabel

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLinkedBranch

Unlink a branch from an issue.

Input fields for deleteLinkedBranch

Return fields for deleteLinkedBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue the linked branch was unlinked from.

deletePackageVersion

Delete a package version.

Note

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

Return fields for deletePackageVersion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Whether or not the operation succeeded.

deleteProject

Deletes a project.

Input fields for deleteProject

Return fields for deleteProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.

deleteProjectCard

Deletes a project card.

Input fields for deleteProjectCard

Return fields for deleteProjectCard

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.

deleteProjectColumn

Deletes a project column.

Input fields for deleteProjectColumn

Return fields for deleteProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.

deleteProjectV2

Delete a project.

Input fields for deleteProjectV2

Return fields for deleteProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The deleted Project.

deleteProjectV2Field

Delete a project field.

Input fields for deleteProjectV2Field

Return fields for deleteProjectV2Field

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The deleted field.

deleteProjectV2Item

Deletes an item from a Project.

Input fields for deleteProjectV2Item

Return fields for deleteProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

deleteProjectV2Workflow

Deletes a project workflow.

Input fields for deleteProjectV2Workflow

Return fields for deleteProjectV2Workflow

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedWorkflowId (ID)

The ID of the deleted workflow.

projectV2 (ProjectV2)

The project the deleted workflow was in.

deletePullRequestReview

Deletes a pull request review.

Input fields for deletePullRequestReview

Return fields for deletePullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.

deletePullRequestReviewComment

Deletes a pull request review comment.

Input fields for deletePullRequestReviewComment

Return fields for deletePullRequestReviewComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.

pullRequestReviewComment (PullRequestReviewComment)

The deleted pull request review comment.

deleteRef

Delete a Git Ref.

Input fields for deleteRef

Return fields for deleteRef

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteRepositoryRuleset

Delete a repository ruleset.

Input fields for deleteRepositoryRuleset

Return fields for deleteRepositoryRuleset

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussion

Deletes a team discussion.

Input fields for deleteTeamDiscussion

Return fields for deleteTeamDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussionComment

Deletes a team discussion comment.

Input fields for deleteTeamDiscussionComment

Return fields for deleteTeamDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteUserList

Deletes a user list.

Input fields for deleteUserList

Return fields for deleteUserList

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The owner of the list that will be deleted.

deleteVerifiableDomain

Deletes a verifiable domain.

Input fields for deleteVerifiableDomain

Return fields for deleteVerifiableDomain

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owning account from which the domain was deleted.

dequeuePullRequest

Remove a pull request from the merge queue.

Input fields for dequeuePullRequest

Return fields for dequeuePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry of the dequeued pull request.

disablePullRequestAutoMerge

Disable auto merge on the given pull request.

Input fields for disablePullRequestAutoMerge

Return fields for disablePullRequestAutoMerge

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto merge was disabled on.

dismissPullRequestReview

Dismisses an approved or rejected pull request review.

Input fields for dismissPullRequestReview

Return fields for dismissPullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

dismissRepositoryVulnerabilityAlert

Dismisses the Dependabot alert.

Input fields for dismissRepositoryVulnerabilityAlert

Return fields for dismissRepositoryVulnerabilityAlert

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryVulnerabilityAlert (RepositoryVulnerabilityAlert)

The Dependabot alert that was dismissed.

enablePullRequestAutoMerge

Enable the default auto-merge on a pull request.

Input fields for enablePullRequestAutoMerge

Return fields for enablePullRequestAutoMerge

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto-merge was enabled on.

enqueuePullRequest

Add a pull request to the merge queue.

Input fields for enqueuePullRequest

Return fields for enqueuePullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry for the enqueued pull request.

followOrganization

Follow an organization.

Input fields for followOrganization

Return fields for followOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was followed.

followUser

Follow a user.

Input fields for followUser

Return fields for followUser

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.

grantEnterpriseOrganizationsMigratorRole

Grant the migrator role to a user for all organizations under an enterprise account.

Input fields for grantEnterpriseOrganizationsMigratorRole

Return fields for grantEnterpriseOrganizationsMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role applied to for the given user.

grantMigratorRole

Grant the migrator role to a user or a team.

Input fields for grantMigratorRole

Return fields for grantMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

importProject

Creates a new project by importing columns and a list of issues/PRs.

Note

importProject is available under the Import project preview. During the preview period, the API may change without notice.

Input fields for importProject

Return fields for importProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

inviteEnterpriseAdmin

Invite someone to become an administrator of the enterprise.

Input fields for inviteEnterpriseAdmin

Return fields for inviteEnterpriseAdmin

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The created enterprise administrator invitation.

linkProjectV2ToRepository

Links a project to a repository.

Input fields for linkProjectV2ToRepository

Return fields for linkProjectV2ToRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is linked to.

linkProjectV2ToTeam

Links a project to a team.

Input fields for linkProjectV2ToTeam

Return fields for linkProjectV2ToTeam

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is linked to.

linkRepositoryToProject

Creates a repository link for a project.

Input fields for linkRepositoryToProject

Return fields for linkRepositoryToProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

lockLockable

Lock a lockable object.

Input fields for lockLockable

Return fields for lockLockable

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the chosen comment.

markFileAsViewed

Mark a pull request file as viewed.

Input fields for markFileAsViewed

Return fields for markFileAsViewed

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

markNotificationAsDone

Marks a notification as done.

Input fields for markNotificationAsDone

Return fields for markNotificationAsDone

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

viewer (User)

The user that the notification belongs to.

markProjectV2AsTemplate

Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.

Input fields for markProjectV2AsTemplate

Return fields for markProjectV2AsTemplate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

markPullRequestReadyForReview

Marks a pull request ready for review.

Input fields for markPullRequestReadyForReview

Return fields for markPullRequestReadyForReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.

mergeBranch

Merge a head into a branch.

Input fields for mergeBranch

Return fields for mergeBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.

mergePullRequest

Merge a pull request.

Input fields for mergePullRequest

Return fields for mergePullRequest

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was merged.

minimizeComment

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

Input fields for minimizeComment

Return fields for minimizeComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.

moveProjectCard

Moves a project card to another place.

Input fields for moveProjectCard

Return fields for moveProjectCard

NameDescription

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.

moveProjectColumn

Moves a project column to another place.

Input fields for moveProjectColumn

Return fields for moveProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.

pinIssue

Pin an issue to a repository.

Input fields for pinIssue

Return fields for pinIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

publishSponsorsTier

Publish an existing sponsorship tier that is currently still a draft to a GitHub Sponsors profile.

Input fields for publishSponsorsTier

Return fields for publishSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was published.

regenerateEnterpriseIdentityProviderRecoveryCodes

Regenerates the identity provider recovery codes for an enterprise.

Input fields for regenerateEnterpriseIdentityProviderRecoveryCodes

Return fields for regenerateEnterpriseIdentityProviderRecoveryCodes

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

regenerateVerifiableDomainToken

Regenerates a verifiable domain's verification token.

Input fields for regenerateVerifiableDomainToken

Return fields for regenerateVerifiableDomainToken

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

verificationToken (String)

The verification token that was generated.

rejectDeployments

Reject all pending deployments under one or more environments.

Input fields for rejectDeployments

Return fields for rejectDeployments

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

removeAssigneesFromAssignable

Removes assignees from an assignable object.

Input fields for removeAssigneesFromAssignable

Return fields for removeAssigneesFromAssignable

NameDescription

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

removeEnterpriseAdmin

Removes an administrator from the enterprise.

Input fields for removeEnterpriseAdmin

Return fields for removeEnterpriseAdmin

NameDescription

admin (User)

The user who was removed as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

message (String)

A message confirming the result of removing an administrator.

viewer (User)

The viewer performing the mutation.

removeEnterpriseIdentityProvider

Removes the identity provider from an enterprise.

Input fields for removeEnterpriseIdentityProvider

Return fields for removeEnterpriseIdentityProvider

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider that was removed from the enterprise.

removeEnterpriseMember

Removes a user from all organizations within the enterprise.

Input fields for removeEnterpriseMember

Return fields for removeEnterpriseMember

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

user (User)

The user that was removed from the enterprise.

viewer (User)

The viewer performing the mutation.

removeEnterpriseOrganization

Removes an organization from the enterprise.

Input fields for removeEnterpriseOrganization

Return fields for removeEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

organization (Organization)

The organization that was removed from the enterprise.

viewer (User)

The viewer performing the mutation.

removeEnterpriseSupportEntitlement

Removes a support entitlement from an enterprise member.

Input fields for removeEnterpriseSupportEntitlement

Return fields for removeEnterpriseSupportEntitlement

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of removing the support entitlement.

removeLabelsFromLabelable

Removes labels from a Labelable object.

Input fields for removeLabelsFromLabelable

Return fields for removeLabelsFromLabelable

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The Labelable the labels were removed from.

removeOutsideCollaborator

Removes outside collaborator from all repositories in an organization.

Input fields for removeOutsideCollaborator

Return fields for removeOutsideCollaborator

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

removedUser (User)

The user that was removed as an outside collaborator.

removeReaction

Removes a reaction from a subject.

Input fields for removeReaction

Return fields for removeReaction

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

removeStar

Removes a star from a Starrable.

Input fields for removeStar

Return fields for removeStar

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

removeUpvote

Remove an upvote to a discussion or discussion comment.

Input fields for removeUpvote

Return fields for removeUpvote

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

reopenDiscussion

Reopen a discussion.

Input fields for reopenDiscussion

Return fields for reopenDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was reopened.

reopenIssue

Reopen a issue.

Input fields for reopenIssue

Return fields for reopenIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.

reopenPullRequest

Reopen a pull request.

Input fields for reopenPullRequest

Return fields for reopenPullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.

requestReviews

Set review requests on a pull request.

Input fields for requestReviews

Return fields for requestReviews

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.

rerequestCheckSuite

Rerequests an existing check suite.

Input fields for rerequestCheckSuite

Return fields for rerequestCheckSuite

NameDescription

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

resolveReviewThread

Marks a review thread as resolved.

Input fields for resolveReviewThread

Return fields for resolveReviewThread

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

retireSponsorsTier

Retire a published payment tier from your GitHub Sponsors profile so it cannot be used to start new sponsorships.

Input fields for retireSponsorsTier

Return fields for retireSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was retired.

revertPullRequest

Create a pull request that reverts the changes from a merged pull request.

Input fields for revertPullRequest

Return fields for revertPullRequest

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reverted.

revertPullRequest (PullRequest)

The new pull request that reverts the input pull request.

revokeEnterpriseOrganizationsMigratorRole

Revoke the migrator role to a user for all organizations under an enterprise account.

Input fields for revokeEnterpriseOrganizationsMigratorRole

Return fields for revokeEnterpriseOrganizationsMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role revoked for the given user.

revokeMigratorRole

Revoke the migrator role from a user or a team.

Input fields for revokeMigratorRole

Return fields for revokeMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

setEnterpriseIdentityProvider

Creates or updates the identity provider for an enterprise.

Input fields for setEnterpriseIdentityProvider

Return fields for setEnterpriseIdentityProvider

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

setOrganizationInteractionLimit

Set an organization level interaction limit for an organization's public repositories.

Input fields for setOrganizationInteractionLimit

Return fields for setOrganizationInteractionLimit

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that the interaction limit was set for.

setRepositoryInteractionLimit

Sets an interaction limit setting for a repository.

Input fields for setRepositoryInteractionLimit

Return fields for setRepositoryInteractionLimit

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that the interaction limit was set for.

setUserInteractionLimit

Set a user level interaction limit for an user's public repositories.

Input fields for setUserInteractionLimit

Return fields for setUserInteractionLimit

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that the interaction limit was set for.

startOrganizationMigration

Starts a GitHub Enterprise Importer organization migration.

Input fields for startOrganizationMigration

Return fields for startOrganizationMigration

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

orgMigration (OrganizationMigration)

The new organization migration.

startRepositoryMigration

Starts a GitHub Enterprise Importer (GEI) repository migration.

Input fields for startRepositoryMigration

Return fields for startRepositoryMigration

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryMigration (RepositoryMigration)

The new repository migration.

submitPullRequestReview

Submits a pending pull request review.

Input fields for submitPullRequestReview

Return fields for submitPullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.

transferEnterpriseOrganization

Transfer an organization from one enterprise to another enterprise.

Input fields for transferEnterpriseOrganization

Return fields for transferEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization for which a transfer was initiated.

transferIssue

Transfer an issue to a different repository.

Input fields for transferIssue

Return fields for transferIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.

unarchiveProjectV2Item

Unarchives a ProjectV2Item.

Input fields for unarchiveProjectV2Item

Return fields for unarchiveProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item unarchived from the project.

unarchiveRepository

Unarchives a repository.

Input fields for unarchiveRepository

Return fields for unarchiveRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.

unfollowOrganization

Unfollow an organization.

Input fields for unfollowOrganization

Return fields for unfollowOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was unfollowed.

unfollowUser

Unfollow a user.

Input fields for unfollowUser

Return fields for unfollowUser

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.

unlinkProjectV2FromRepository

Unlinks a project from a repository.

Input fields for unlinkProjectV2FromRepository

Return fields for unlinkProjectV2FromRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is no longer linked to.

unlinkProjectV2FromTeam

Unlinks a project to a team.

Input fields for unlinkProjectV2FromTeam

Return fields for unlinkProjectV2FromTeam

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is unlinked from.

unlinkRepositoryFromProject

Deletes a repository link from a project.

Input fields for unlinkRepositoryFromProject

Return fields for unlinkRepositoryFromProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

unlockLockable

Unlock a lockable object.

Input fields for unlockLockable

Return fields for unlockLockable

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

unlockedRecord (Lockable)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the comment.

unmarkFileAsViewed

Unmark a pull request file as viewed.

Input fields for unmarkFileAsViewed

Return fields for unmarkFileAsViewed

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

Input fields for unmarkIssueAsDuplicate

Return fields for unmarkIssueAsDuplicate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

The issue or pull request that was marked as a duplicate.

unmarkProjectV2AsTemplate

Unmark a project as a template.

Input fields for unmarkProjectV2AsTemplate

Return fields for unmarkProjectV2AsTemplate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

unminimizeComment

Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.

Input fields for unminimizeComment

Return fields for unminimizeComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

unminimizedComment (Minimizable)

The comment that was unminimized.

unpinIssue

Unpin a pinned issue from a repository.

Input fields for unpinIssue

Return fields for unpinIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID)

The id of the pinned issue that was unpinned.

issue (Issue)

The issue that was unpinned.

unresolveReviewThread

Marks a review thread as unresolved.

Input fields for unresolveReviewThread

Return fields for unresolveReviewThread

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

unsubscribeFromNotifications

Unsubscribes from notifications.

Input fields for unsubscribeFromNotifications

Return fields for unsubscribeFromNotifications

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

updateBranchProtectionRule

Update a branch protection rule.

Input fields for updateBranchProtectionRule

Return fields for updateBranchProtectionRule

NameDescription

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Update a check run.

Input fields for updateCheckRun

Return fields for updateCheckRun

NameDescription

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateDiscussion

Update a discussion.

Input fields for updateDiscussion

Return fields for updateDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The modified discussion.

updateDiscussionComment

Update the contents of a comment on a Discussion.

Input fields for updateDiscussionComment

Return fields for updateDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The modified discussion comment.

updateEnterpriseAdministratorRole

Updates the role of an enterprise administrator.

Input fields for updateEnterpriseAdministratorRole

Return fields for updateEnterpriseAdministratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the administrator's role.

updateEnterpriseAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an enterprise.

Input fields for updateEnterpriseAllowPrivateRepositoryForkingSetting

Return fields for updateEnterpriseAllowPrivateRepositoryForkingSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated allow private repository forking setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated base repository permission setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can change repository visibility setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can create repositories setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete issues setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete repositories setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can invite collaborators setting.

message (String)

A message confirming the result of updating the members can invite collaborators setting.

updateEnterpriseMembersCanMakePurchasesSetting

Sets whether or not an organization owner can make purchases.

Input fields for updateEnterpriseMembersCanMakePurchasesSetting

Return fields for updateEnterpriseMembersCanMakePurchasesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can make purchases setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can update protected branches setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can view dependency insights setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated organization projects setting.

message (String)

A message confirming the result of updating the organization projects setting.

updateEnterpriseOwnerOrganizationRole

Updates the role of an enterprise owner with an organization.

Input fields for updateEnterpriseOwnerOrganizationRole

Return fields for updateEnterpriseOwnerOrganizationRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the owner's organization role.

updateEnterpriseProfile

Updates an enterprise's profile.

Input fields for updateEnterpriseProfile

Return fields for updateEnterpriseProfile

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

updateEnterpriseRepositoryProjectsSetting

Sets whether repository projects are enabled for a enterprise.

Input fields for updateEnterpriseRepositoryProjectsSetting

Return fields for updateEnterpriseRepositoryProjectsSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated repository projects setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated team discussions setting.

message (String)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated two factor authentication required setting.

message (String)

A message confirming the result of updating the two factor authentication required setting.

updateEnvironment

Updates an environment.

Input fields for updateEnvironment

Return fields for updateEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The updated environment.

updateIpAllowListEnabledSetting

Sets whether an IP allow list is enabled on an owner.

Input fields for updateIpAllowListEnabledSetting

Return fields for updateIpAllowListEnabledSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIpAllowListEntry

Updates an IP allow list entry.

Input fields for updateIpAllowListEntry

Return fields for updateIpAllowListEntry

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIssue

Updates an Issue.

Input fields for updateIssue

Return fields for updateIssue

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.

updateIssueComment

Updates an IssueComment object.

Input fields for updateIssueComment

Return fields for updateIssueComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.

updateLabel

Updates an existing label.

Note

updateLabel is available under the Labels preview. During the preview period, the API may change without notice.

Input fields for updateLabel

Return fields for updateLabel

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

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

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the allow private repository forking setting.

organization (Organization)

The organization with the updated allow private repository forking setting.

updateOrganizationWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for repositories in an organization.

Input fields for updateOrganizationWebCommitSignoffSetting

Return fields for updateOrganizationWebCommitSignoffSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

organization (Organization)

The organization with the updated web commit signoff setting.

updatePatreonSponsorability

Toggle the setting for your GitHub Sponsors profile that allows other GitHub accounts to sponsor you on GitHub while paying for the sponsorship on Patreon. Only applicable when you have a GitHub Sponsors profile and have connected your GitHub account with Patreon.

Input fields for updatePatreonSponsorability

Return fields for updatePatreonSponsorability

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsListing (SponsorsListing)

The GitHub Sponsors profile.

updateProject

Updates an existing project.

Input fields for updateProject

Return fields for updateProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Updates an existing project card.

Input fields for updateProjectCard

Return fields for updateProjectCard

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Updates an existing project column.

Input fields for updateProjectColumn

Return fields for updateProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

updateProjectV2

Updates an existing project.

Input fields for updateProjectV2

Return fields for updateProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2Collaborators

Update the collaborators on a team or a project.

Input fields for updateProjectV2Collaborators

Return fields for updateProjectV2Collaborators

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators (ProjectV2ActorConnection)

The collaborators granted a role.

updateProjectV2DraftIssue

Updates a draft issue within a Project.

Input fields for updateProjectV2DraftIssue

Return fields for updateProjectV2DraftIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectV2ItemFieldValue

This mutation updates the value of a field for an item in a Project. Currently only single-select, text, number, date, and iteration fields are supported.

Input fields for updateProjectV2ItemFieldValue

Return fields for updateProjectV2ItemFieldValue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

updateProjectV2ItemPosition

This mutation updates the position of the item in the project, where the position represents the priority of an item.

Input fields for updateProjectV2ItemPosition

Return fields for updateProjectV2ItemPosition

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

updatePullRequest

Update a pull request.

Input fields for updatePullRequest

Return fields for updatePullRequest

NameDescription

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

updatePullRequestBranch

Merge or Rebase HEAD from upstream branch into pull request branch.

Input fields for updatePullRequestBranch

Return fields for updatePullRequestBranch

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

updatePullRequestReview

Updates the body of a pull request review.

Input fields for updatePullRequestReview

Return fields for updatePullRequestReview

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The updated pull request review.

updatePullRequestReviewComment

Updates a pull request review comment.

Input fields for updatePullRequestReviewComment

Return fields for updatePullRequestReviewComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.

updateRef

Update a Git Ref.

Input fields for updateRef

Return fields for updateRef

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

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.

Note

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

Return fields for updateRefs

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateRepository

Update information about a repository.

Input fields for updateRepository

Return fields for updateRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateRepositoryRuleset

Update a repository ruleset.

Input fields for updateRepositoryRuleset

Return fields for updateRepositoryRuleset

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ruleset (RepositoryRuleset)

The newly created Ruleset.

updateRepositoryWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for a repository.

Input fields for updateRepositoryWebCommitSignoffSetting

Return fields for updateRepositoryWebCommitSignoffSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

repository (Repository)

The updated repository.

updateSponsorshipPreferences

Change visibility of your sponsorship and opt in or out of email updates from the maintainer.

Input fields for updateSponsorshipPreferences

Return fields for updateSponsorshipPreferences

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was updated.

updateSubscription

Updates the state for subscribable subjects.

Input fields for updateSubscription

Return fields for updateSubscription

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.

updateTeamDiscussion

Updates a team discussion.

Input fields for updateTeamDiscussion

Return fields for updateTeamDiscussion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.

updateTeamDiscussionComment

Updates a discussion comment.

Input fields for updateTeamDiscussionComment

Return fields for updateTeamDiscussionComment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.

updateTeamReviewAssignment

Updates team review assignment.

Note

updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.

Input fields for updateTeamReviewAssignment

Return fields for updateTeamReviewAssignment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.

updateTeamsRepository

Update team repository.

Input fields for updateTeamsRepository

Return fields for updateTeamsRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was updated.

teams ([Team!])

The teams granted permission on the repository.

updateTopics

Replaces the repository's topics with the given topics.

Input fields for updateTopics

Return fields for updateTopics

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invalidTopicNames ([String!])

Names of the provided topics that are not valid.

repository (Repository)

The updated repository.

updateUserList

Updates an existing user list.

Input fields for updateUserList

Return fields for updateUserList

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

list (UserList)

The list that was just updated.

updateUserListsForItem

Updates which of the viewer's lists an item belongs to.

Input fields for updateUserListsForItem

Return fields for updateUserListsForItem

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (UserListItems)

The item that was added.

lists ([UserList!])

The lists to which this item belongs.

user (User)

The user who owns the lists.

verifyVerifiableDomain

Verify that a verifiable domain has the expected DNS record.

Input fields for verifyVerifiableDomain

Return fields for verifyVerifiableDomain

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was verified.