Mutations
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. Themutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such asPOST,PATCH, andDELETE.
For more information, seeForming calls with GraphQL.
abortQueuedMigrations
Clear all of a customer's queued migrations.
Input fields forabortQueuedMigrations
input(AbortQueuedMigrationsInput!)
Return fields forabortQueuedMigrations
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
abortRepositoryMigration
Abort a repository migration queued or in progress.
Input fields forabortRepositoryMigration
input(AbortRepositoryMigrationInput!)
Return fields forabortRepositoryMigration
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
acceptEnterpriseAdministratorInvitation
Accepts a pending invitation for a user to become an administrator of an enterprise.
Input fields foracceptEnterpriseAdministratorInvitation
Return fields foracceptEnterpriseAdministratorInvitation
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was accepted. |
| A message confirming the result of accepting an administrator invitation. |
acceptEnterpriseMemberInvitation
Accepts a pending invitation for a user to become an unaffiliated member of an enterprise.
Input fields foracceptEnterpriseMemberInvitation
Return fields foracceptEnterpriseMemberInvitation
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was accepted. |
| A message confirming the result of accepting an unaffiliated member invitation. |
acceptTopicSuggestion
Applies a suggested topic to the repository.
Input fields foracceptTopicSuggestion
input(AcceptTopicSuggestionInput!)
Return fields foracceptTopicSuggestion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The accepted topic. Warning
Suggested topics are no longer supported Removal on 2024-04-01 UTC. |
accessUserNamespaceRepository
Access user namespace repository for a temporary duration.
Input fields foraccessUserNamespaceRepository
Return fields foraccessUserNamespaceRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The time that repository access expires at. |
| The repository that is temporarily accessible. |
addAssigneesToAssignable
Adds assignees to an assignable object.
Input fields foraddAssigneesToAssignable
input(AddAssigneesToAssignableInput!)
Return fields foraddAssigneesToAssignable
| 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 foraddComment
input(AddCommentInput!)
Return fields foraddComment
| 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 foraddDiscussionComment
input(AddDiscussionCommentInput!)
Return fields foraddDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created discussion comment. |
addDiscussionPollVote
Vote for an option in a discussion poll.
Input fields foraddDiscussionPollVote
input(AddDiscussionPollVoteInput!)
Return fields foraddDiscussionPollVote
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The poll option that a vote was added to. |
addEnterpriseOrganizationMember
Adds enterprise members to an organization within the enterprise.
addEnterpriseSupportEntitlement
Adds a support entitlement to an enterprise member.
addLabelsToLabelable
Adds labels to a labelable object.
Input fields foraddLabelsToLabelable
input(AddLabelsToLabelableInput!)
Return fields foraddLabelsToLabelable
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was labeled. |
addProjectCard
Adds a card to a ProjectColumn. EithercontentId ornote must be provided butnot both.
Warning
addProjectCard is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields foraddProjectCard
input(AddProjectCardInput!)
Return fields foraddProjectCard
| 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.
Warning
addProjectColumn is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields foraddProjectColumn
input(AddProjectColumnInput!)
Return fields foraddProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The edge from the project's column connection. |
| The project. |
addProjectV2DraftIssue
Creates a new draft issue and add it to a Project.
Input fields foraddProjectV2DraftIssue
input(AddProjectV2DraftIssueInput!)
Return fields foraddProjectV2DraftIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The draft issue added to the project. |
addProjectV2ItemById
Links an existing content instance to a Project.
Input fields foraddProjectV2ItemById
input(AddProjectV2ItemByIdInput!)
Return fields foraddProjectV2ItemById
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item added to the project. |
addPullRequestReview
Adds a review to a Pull Request.
Input fields foraddPullRequestReview
input(AddPullRequestReviewInput!)
Return fields foraddPullRequestReview
| 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 foraddPullRequestReviewComment
Return fields foraddPullRequestReviewComment
| 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 foraddPullRequestReviewThread
input(AddPullRequestReviewThreadInput!)
Return fields foraddPullRequestReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created thread. |
addPullRequestReviewThreadReply
Adds a reply to an existing Pull Request Review Thread.
Input fields foraddPullRequestReviewThreadReply
Return fields foraddPullRequestReviewThreadReply
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created reply. |
addReaction
Adds a reaction to a subject.
Input fields foraddReaction
input(AddReactionInput!)
Return fields foraddReaction
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reaction groups for the subject. |
| The reactable subject. |
addStar
Adds a star to a Starrable.
Input fields foraddStar
input(AddStarInput!)
Return fields foraddStar
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
addSubIssue
Adds a sub-issue to a given issue.
Input fields foraddSubIssue
input(AddSubIssueInput!)
Return fields foraddSubIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The parent issue that the sub-issue was added to. |
| The sub-issue of the parent. |
addUpvote
Add an upvote to a discussion or discussion comment.
Input fields foraddUpvote
input(AddUpvoteInput!)
Return fields foraddUpvote
| 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 foraddVerifiableDomain
input(AddVerifiableDomainInput!)
Return fields foraddVerifiableDomain
| 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 forapproveDeployments
input(ApproveDeploymentsInput!)
Return fields forapproveDeployments
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
approveVerifiableDomain
Approve a verifiable domain for notification delivery.
Input fields forapproveVerifiableDomain
input(ApproveVerifiableDomainInput!)
Return fields forapproveVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was approved. |
archiveProjectV2Item
Archives a ProjectV2Item.
Input fields forarchiveProjectV2Item
input(ArchiveProjectV2ItemInput!)
Return fields forarchiveProjectV2Item
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item archived from the project. |
archiveRepository
Marks a repository as archived.
Input fields forarchiveRepository
input(ArchiveRepositoryInput!)
Return fields forarchiveRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was marked as archived. |
cancelEnterpriseAdminInvitation
Cancels a pending invitation for an administrator to join an enterprise.
Input fields forcancelEnterpriseAdminInvitation
Return fields forcancelEnterpriseAdminInvitation
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was canceled. |
| A message confirming the result of canceling an administrator invitation. |
cancelEnterpriseMemberInvitation
Cancels a pending invitation for an unaffiliated member to join an enterprise.
Input fields forcancelEnterpriseMemberInvitation
Return fields forcancelEnterpriseMemberInvitation
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was canceled. |
| A message confirming the result of canceling an member invitation. |
cancelSponsorship
Cancel an active sponsorship.
Input fields forcancelSponsorship
input(CancelSponsorshipInput!)
Return fields forcancelSponsorship
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was being used at the time of cancellation. |
changeUserStatus
Update your status on GitHub.
Input fields forchangeUserStatus
input(ChangeUserStatusInput!)
Return fields forchangeUserStatus
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Your updated status. |
clearLabelsFromLabelable
Clears all labels from a labelable object.
Input fields forclearLabelsFromLabelable
input(ClearLabelsFromLabelableInput!)
Return fields forclearLabelsFromLabelable
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was unlabeled. |
clearProjectV2ItemFieldValue
This mutation clears the value of a field for an item in a Project. Currentlyonly text, number, date, assignees, labels, single-select, iteration andmilestone fields are supported.
Input fields forclearProjectV2ItemFieldValue
Return fields forclearProjectV2ItemFieldValue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated item. |
cloneProject
Creates a new project by cloning configuration from an existing project.
Warning
cloneProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forcloneProject
input(CloneProjectInput!)
Return fields forcloneProject
| 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 forcloneTemplateRepository
input(CloneTemplateRepositoryInput!)
Return fields forcloneTemplateRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
closeDiscussion
Close a discussion.
Input fields forcloseDiscussion
input(CloseDiscussionInput!)
Return fields forcloseDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that was closed. |
closeIssue
Close an issue.
Input fields forcloseIssue
input(CloseIssueInput!)
Return fields forcloseIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was closed. |
closePullRequest
Close a pull request.
Input fields forclosePullRequest
input(ClosePullRequestInput!)
Return fields forclosePullRequest
| 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.
Warning
convertProjectCardNoteToIssue is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forconvertProjectCardNoteToIssue
Return fields forconvertProjectCardNoteToIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
convertProjectV2DraftIssueItemToIssue
Converts a projectV2 draft issue item to an issue.
Input fields forconvertProjectV2DraftIssueItemToIssue
Return fields forconvertProjectV2DraftIssueItemToIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project item. |
convertPullRequestToDraft
Converts a pull request to draft.
Input fields forconvertPullRequestToDraft
input(ConvertPullRequestToDraftInput!)
Return fields forconvertPullRequestToDraft
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is now a draft. |
copyProjectV2
Copy a project.
Input fields forcopyProjectV2
input(CopyProjectV2Input!)
Return fields forcopyProjectV2
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The copied project. |
createAttributionInvitation
Invites a user to claim reattributable data.
Input fields forcreateAttributionInvitation
Return fields forcreateAttributionInvitation
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owner scoping the reattributable data. |
| The account owning the data to reattribute. |
| The account which may claim the data. |
createBranchProtectionRule
Create a new branch protection rule.
Input fields forcreateBranchProtectionRule
input(CreateBranchProtectionRuleInput!)
Return fields forcreateBranchProtectionRule
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
createCheckRun
Create a check run.
Input fields forcreateCheckRun
input(CreateCheckRunInput!)
Return fields forcreateCheckRun
| Name | Description |
|---|---|
| The newly created check run. |
| A unique identifier for the client performing the mutation. |
createCheckSuite
Create a check suite.
Input fields forcreateCheckSuite
input(CreateCheckSuiteInput!)
Return fields forcreateCheckSuite
| 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 providedbranch and also updates that branch to point to the new commit.It can be thought of as similar togit commit.
Locating a Branch
Commits are appended to abranch of typeRef.This must refer to a git branch (i.e. the fully qualified path mustbegin withrefs/heads/, although including this prefix is optional.
Callers may specify thebranch to commit to either by its global nodeID or by passing both ofrepositoryNameWithOwner andrefName. Formore details see the documentation forCommittableBranch.
Describing Changes
fileChanges are specified as aFilesChanges object describingFileAdditions andFileDeletions.
Please see the documentation forFileChanges for more information onhow to use this argument to describe any set of file changes.
Authorship
Similar to the web commit interface, this mutation does not supportspecifying the author or committer of the commit and will not addsupport for this in the future.
A commit created by a successful execution of this mutation will beauthored by the owner of the credential which authenticates the APIrequest. The committer will be identical to that of commits authoredusing the web interface.
If you need full control over author and committer information, pleaseuse the Git Database REST API instead.
Commit Signing
Commits made using this mutation are automatically signed by GitHub ifsupported and will be marked as verified in the user interface.
Input fields forcreateCommitOnBranch
input(CreateCommitOnBranchInput!)
Return fields forcreateCommitOnBranch
| 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.
Input fields forcreateDeployment
input(CreateDeploymentInput!)
Return fields forcreateDeployment
| 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.
Input fields forcreateDeploymentStatus
input(CreateDeploymentStatusInput!)
Return fields forcreateDeploymentStatus
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new deployment status. |
createDiscussion
Create a discussion.
Input fields forcreateDiscussion
input(CreateDiscussionInput!)
Return fields forcreateDiscussion
| 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. A personal accesstoken used to create an organization is implicitly permitted to update theorganization it created, if the organization is part of an enterprise that hasSAML enabled or uses Enterprise Managed Users. If the organization is not partof such an enterprise, and instead has SAML enabled for it individually, thetoken will then require SAML authorization to continue working against that organization.
Input fields forcreateEnterpriseOrganization
Return fields forcreateEnterpriseOrganization
| 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 forcreateEnvironment
input(CreateEnvironmentInput!)
Return fields forcreateEnvironment
| 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 forcreateIpAllowListEntry
input(CreateIpAllowListEntryInput!)
Return fields forcreateIpAllowListEntry
| 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 forcreateIssue
input(CreateIssueInput!)
Return fields forcreateIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new issue. |
createIssueType
Creates a new issue type.
Input fields forcreateIssueType
input(CreateIssueTypeInput!)
Return fields forcreateIssueType
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created issue type. |
createLabel
Creates a new label.
Input fields forcreateLabel
input(CreateLabelInput!)
Return fields forcreateLabel
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new label. |
createLinkedBranch
Create a branch linked to an issue.
Input fields forcreateLinkedBranch
input(CreateLinkedBranchInput!)
Return fields forcreateLinkedBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was linked to. |
| The new branch issue reference. |
createMigrationSource
Creates a GitHub Enterprise Importer (GEI) migration source.
Input fields forcreateMigrationSource
input(CreateMigrationSourceInput!)
Return fields forcreateMigrationSource
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The created migration source. |
createProject
Creates a new project.
Warning
createProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forcreateProject
input(CreateProjectInput!)
Return fields forcreateProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new project. |
createProjectV2
Creates a new project.
Input fields forcreateProjectV2
input(CreateProjectV2Input!)
Return fields forcreateProjectV2
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new project. |
createProjectV2Field
Create a new project field.
Input fields forcreateProjectV2Field
input(CreateProjectV2FieldInput!)
Return fields forcreateProjectV2Field
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new field. |
createProjectV2StatusUpdate
Creates a status update within a Project.
Input fields forcreateProjectV2StatusUpdate
Return fields forcreateProjectV2StatusUpdate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The status update updated in the project. |
createPullRequest
Create a new pull request.
Input fields forcreatePullRequest
input(CreatePullRequestInput!)
Return fields forcreatePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new pull request. |
createRef
Create a new Git Ref.
Input fields forcreateRef
input(CreateRefInput!)
Return fields forcreateRef
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created ref. |
createRepository
Create a new repository.
Input fields forcreateRepository
input(CreateRepositoryInput!)
Return fields forcreateRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
createRepositoryRuleset
Create a repository ruleset.
Input fields forcreateRepositoryRuleset
input(CreateRepositoryRulesetInput!)
Return fields forcreateRepositoryRuleset
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created Ruleset. |
createSponsorsListing
Create a GitHub Sponsors profile to allow others to sponsor you or your organization.
Input fields forcreateSponsorsListing
input(CreateSponsorsListingInput!)
Return fields forcreateSponsorsListing
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new GitHub Sponsors profile. |
createSponsorsTier
Create a new payment tier for your GitHub Sponsors profile.
Input fields forcreateSponsorsTier
input(CreateSponsorsTierInput!)
Return fields forcreateSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new tier. |
createSponsorship
Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.
Input fields forcreateSponsorship
input(CreateSponsorshipInput!)
Return fields forcreateSponsorship
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The sponsorship that was started. |
createSponsorships
Make many sponsorships for different sponsorable users or organizations atonce. Can only sponsor those who have a public GitHub Sponsors profile.
Input fields forcreateSponsorships
input(CreateSponsorshipsInput!)
Return fields forcreateSponsorships
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The users and organizations who received a sponsorship. |
createTeamDiscussion
Creates a new team discussion.
Input fields forcreateTeamDiscussion
input(CreateTeamDiscussionInput!)
Return fields forcreateTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new discussion. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide athttps://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 forcreateTeamDiscussionComment
Return fields forcreateTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new comment. Warning
The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide athttps://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 forcreateUserList
input(CreateUserListInput!)
Return fields forcreateUserList
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The list that was just created. |
| The user who created the list. |
declineTopicSuggestion
Rejects a suggested topic for the repository.
Input fields fordeclineTopicSuggestion
input(DeclineTopicSuggestionInput!)
Return fields fordeclineTopicSuggestion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The declined topic. Warning
Suggested topics are no longer supported Removal on 2024-04-01 UTC. |
deleteBranchProtectionRule
Delete a branch protection rule.
Input fields fordeleteBranchProtectionRule
input(DeleteBranchProtectionRuleInput!)
Return fields fordeleteBranchProtectionRule
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDeployment
Deletes a deployment.
Input fields fordeleteDeployment
input(DeleteDeploymentInput!)
Return fields fordeleteDeployment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDiscussion
Delete a discussion and all of its replies.
Input fields fordeleteDiscussion
input(DeleteDiscussionInput!)
Return fields fordeleteDiscussion
| 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 fordeleteDiscussionComment
input(DeleteDiscussionCommentInput!)
Return fields fordeleteDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion comment that was just deleted. |
deleteEnvironment
Deletes an environment.
Input fields fordeleteEnvironment
input(DeleteEnvironmentInput!)
Return fields fordeleteEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteIpAllowListEntry
Deletes an IP allow list entry.
Input fields fordeleteIpAllowListEntry
input(DeleteIpAllowListEntryInput!)
Return fields fordeleteIpAllowListEntry
| 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 fordeleteIssue
input(DeleteIssueInput!)
Return fields fordeleteIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository the issue belonged to. |
deleteIssueComment
Deletes an IssueComment object.
Input fields fordeleteIssueComment
input(DeleteIssueCommentInput!)
Return fields fordeleteIssueComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteIssueType
Delete an issue type.
Input fields fordeleteIssueType
input(DeleteIssueTypeInput!)
Return fields fordeleteIssueType
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the deleted issue type. |
deleteLabel
Deletes a label.
Input fields fordeleteLabel
input(DeleteLabelInput!)
Return fields fordeleteLabel
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteLinkedBranch
Unlink a branch from an issue.
Input fields fordeleteLinkedBranch
input(DeleteLinkedBranchInput!)
Return fields fordeleteLinkedBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue the linked branch was unlinked from. |
deletePackageVersion
Delete a package version.
Input fields fordeletePackageVersion
input(DeletePackageVersionInput!)
Return fields fordeletePackageVersion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether or not the operation succeeded. |
deleteProject
Deletes a project.
Warning
deleteProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields fordeleteProject
input(DeleteProjectInput!)
Return fields fordeleteProject
| 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.
Warning
deleteProjectCard is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields fordeleteProjectCard
input(DeleteProjectCardInput!)
Return fields fordeleteProjectCard
| 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.
Warning
deleteProjectColumn is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields fordeleteProjectColumn
input(DeleteProjectColumnInput!)
Return fields fordeleteProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted column ID. |
| The project the deleted column was in. |
deleteProjectV2
Delete a project.
Input fields fordeleteProjectV2
input(DeleteProjectV2Input!)
Return fields fordeleteProjectV2
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted Project. |
deleteProjectV2Field
Delete a project field.
Input fields fordeleteProjectV2Field
input(DeleteProjectV2FieldInput!)
Return fields fordeleteProjectV2Field
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted field. |
deleteProjectV2Item
Deletes an item from a Project.
Input fields fordeleteProjectV2Item
input(DeleteProjectV2ItemInput!)
Return fields fordeleteProjectV2Item
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the deleted item. |
deleteProjectV2StatusUpdate
Deletes a project status update.
Input fields fordeleteProjectV2StatusUpdate
Return fields fordeleteProjectV2StatusUpdate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the deleted status update. |
| The project the deleted status update was in. |
deleteProjectV2Workflow
Deletes a project workflow.
Input fields fordeleteProjectV2Workflow
input(DeleteProjectV2WorkflowInput!)
Return fields fordeleteProjectV2Workflow
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the deleted workflow. |
| The project the deleted workflow was in. |
deletePullRequestReview
Deletes a pull request review.
Input fields fordeletePullRequestReview
input(DeletePullRequestReviewInput!)
Return fields fordeletePullRequestReview
| 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 fordeletePullRequestReviewComment
Return fields fordeletePullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request review the deleted comment belonged to. |
| The deleted pull request review comment. |
deleteRef
Delete a Git Ref.
Input fields fordeleteRef
input(DeleteRefInput!)
Return fields fordeleteRef
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteRepositoryRuleset
Delete a repository ruleset.
Input fields fordeleteRepositoryRuleset
input(DeleteRepositoryRulesetInput!)
Return fields fordeleteRepositoryRuleset
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussion
Deletes a team discussion.
Input fields fordeleteTeamDiscussion
input(DeleteTeamDiscussionInput!)
Return fields fordeleteTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussionComment
Deletes a team discussion comment.
Input fields fordeleteTeamDiscussionComment
Return fields fordeleteTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteUserList
Deletes a user list.
Input fields fordeleteUserList
input(DeleteUserListInput!)
Return fields fordeleteUserList
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owner of the list that will be deleted. |
deleteVerifiableDomain
Deletes a verifiable domain.
Input fields fordeleteVerifiableDomain
input(DeleteVerifiableDomainInput!)
Return fields fordeleteVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owning account from which the domain was deleted. |
dequeuePullRequest
Remove a pull request from the merge queue.
Input fields fordequeuePullRequest
input(DequeuePullRequestInput!)
Return fields fordequeuePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry of the dequeued pull request. |
disablePullRequestAutoMerge
Disable auto merge on the given pull request.
Input fields fordisablePullRequestAutoMerge
Return fields fordisablePullRequestAutoMerge
| 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 fordismissPullRequestReview
input(DismissPullRequestReviewInput!)
Return fields fordismissPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The dismissed pull request review. |
dismissRepositoryVulnerabilityAlert
Dismisses the Dependabot alert.
Input fields fordismissRepositoryVulnerabilityAlert
Return fields fordismissRepositoryVulnerabilityAlert
| 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 forenablePullRequestAutoMerge
input(EnablePullRequestAutoMergeInput!)
Return fields forenablePullRequestAutoMerge
| 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. |
enqueuePullRequest
Add a pull request to the merge queue.
Input fields forenqueuePullRequest
input(EnqueuePullRequestInput!)
Return fields forenqueuePullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry for the enqueued pull request. |
followOrganization
Follow an organization.
Input fields forfollowOrganization
input(FollowOrganizationInput!)
Return fields forfollowOrganization
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The organization that was followed. |
followUser
Follow a user.
Input fields forfollowUser
input(FollowUserInput!)
Return fields forfollowUser
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was followed. |
grantEnterpriseOrganizationsMigratorRole
Grant the migrator role to a user for all organizations under an enterprise account.
Input fields forgrantEnterpriseOrganizationsMigratorRole
Return fields forgrantEnterpriseOrganizationsMigratorRole
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| 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 forgrantMigratorRole
input(GrantMigratorRoleInput!)
Return fields forgrantMigratorRole
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
importProject
Creates a new project by importing columns and a list of issues/PRs.
Warning
importProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forimportProject
input(ImportProjectInput!)
Return fields forimportProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new Project!. |
inviteEnterpriseAdmin
Invite someone to become an administrator of the enterprise.
Input fields forinviteEnterpriseAdmin
input(InviteEnterpriseAdminInput!)
Return fields forinviteEnterpriseAdmin
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The created enterprise administrator invitation. |
inviteEnterpriseMember
Invite someone to become an unaffiliated member of the enterprise.
Input fields forinviteEnterpriseMember
input(InviteEnterpriseMemberInput!)
Return fields forinviteEnterpriseMember
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The created enterprise member invitation. |
linkProjectV2ToRepository
Links a project to a repository.
Input fields forlinkProjectV2ToRepository
input(LinkProjectV2ToRepositoryInput!)
Return fields forlinkProjectV2ToRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository the project is linked to. |
linkProjectV2ToTeam
Links a project to a team.
Input fields forlinkProjectV2ToTeam
input(LinkProjectV2ToTeamInput!)
Return fields forlinkProjectV2ToTeam
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team the project is linked to. |
linkRepositoryToProject
Creates a repository link for a project.
Warning
linkRepositoryToProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forlinkRepositoryToProject
input(LinkRepositoryToProjectInput!)
Return fields forlinkRepositoryToProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
lockLockable
Lock a lockable object.
Input fields forlockLockable
input(LockLockableInput!)
Return fields forlockLockable
| 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 formarkDiscussionCommentAsAnswer
Return fields formarkDiscussionCommentAsAnswer
| 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 formarkFileAsViewed
input(MarkFileAsViewedInput!)
Return fields formarkFileAsViewed
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
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 formarkProjectV2AsTemplate
input(MarkProjectV2AsTemplateInput!)
Return fields formarkProjectV2AsTemplate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The project. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Input fields formarkPullRequestReadyForReview
Return fields formarkPullRequestReadyForReview
| 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 formergeBranch
input(MergeBranchInput!)
Return fields formergeBranch
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The resulting merge Commit. |
mergePullRequest
Merge a pull request.
Input fields formergePullRequest
input(MergePullRequestInput!)
Return fields formergePullRequest
| 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 forminimizeComment
input(MinimizeCommentInput!)
Return fields forminimizeComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The comment that was minimized. |
moveProjectCard
Moves a project card to another place.
Warning
moveProjectCard is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields formoveProjectCard
input(MoveProjectCardInput!)
Return fields formoveProjectCard
| 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.
Warning
moveProjectColumn is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields formoveProjectColumn
input(MoveProjectColumnInput!)
Return fields formoveProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new edge of the moved column. |
pinEnvironment
Pin an environment to a repository.
Input fields forpinEnvironment
input(PinEnvironmentInput!)
Return fields forpinEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The environment that was pinned. |
| The pinned environment if we pinned. |
pinIssue
Pin an issue to a repository.
Input fields forpinIssue
input(PinIssueInput!)
Return fields forpinIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was pinned. |
publishSponsorsTier
Publish an existing sponsorship tier that is currently still a draft to a GitHub Sponsors profile.
Input fields forpublishSponsorsTier
input(PublishSponsorsTierInput!)
Return fields forpublishSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was published. |
regenerateEnterpriseIdentityProviderRecoveryCodes
Regenerates the identity provider recovery codes for an enterprise.
Input fields forregenerateEnterpriseIdentityProviderRecoveryCodes
Return fields forregenerateEnterpriseIdentityProviderRecoveryCodes
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The identity provider for the enterprise. |
regenerateVerifiableDomainToken
Regenerates a verifiable domain's verification token.
rejectDeployments
Reject all pending deployments under one or more environments.
Input fields forrejectDeployments
input(RejectDeploymentsInput!)
Return fields forrejectDeployments
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
removeAssigneesFromAssignable
Removes assignees from an assignable object.
Input fields forremoveAssigneesFromAssignable
Return fields forremoveAssigneesFromAssignable
| 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 forremoveEnterpriseAdmin
input(RemoveEnterpriseAdminInput!)
Return fields forremoveEnterpriseAdmin
| 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. |
removeEnterpriseIdentityProvider
Removes the identity provider from an enterprise. Owners of enterprises bothwith and without Enterprise Managed Users may use this mutation.
Input fields forremoveEnterpriseIdentityProvider
Return fields forremoveEnterpriseIdentityProvider
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The identity provider that was removed from the enterprise. |
removeEnterpriseMember
Removes a user from all organizations within the enterprise.
Input fields forremoveEnterpriseMember
input(RemoveEnterpriseMemberInput!)
Return fields forremoveEnterpriseMember
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| The user that was removed from the enterprise. |
| The viewer performing the mutation. |
removeEnterpriseOrganization
Removes an organization from the enterprise.
Input fields forremoveEnterpriseOrganization
Return fields forremoveEnterpriseOrganization
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| The organization that was removed from the enterprise. |
| The viewer performing the mutation. |
removeEnterpriseSupportEntitlement
Removes a support entitlement from an enterprise member.
removeLabelsFromLabelable
Removes labels from a Labelable object.
Input fields forremoveLabelsFromLabelable
input(RemoveLabelsFromLabelableInput!)
Return fields forremoveLabelsFromLabelable
| 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 forremoveOutsideCollaborator
input(RemoveOutsideCollaboratorInput!)
Return fields forremoveOutsideCollaborator
| 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 forremoveReaction
input(RemoveReactionInput!)
Return fields forremoveReaction
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reaction groups for the subject. |
| The reactable subject. |
removeStar
Removes a star from a Starrable.
Input fields forremoveStar
input(RemoveStarInput!)
Return fields forremoveStar
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
removeSubIssue
Removes a sub-issue from a given issue.
Input fields forremoveSubIssue
input(RemoveSubIssueInput!)
Return fields forremoveSubIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The parent of the sub-issue. |
| The sub-issue of the parent. |
removeUpvote
Remove an upvote to a discussion or discussion comment.
Input fields forremoveUpvote
input(RemoveUpvoteInput!)
Return fields forremoveUpvote
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The votable subject. |
reopenDiscussion
Reopen a discussion.
Input fields forreopenDiscussion
input(ReopenDiscussionInput!)
Return fields forreopenDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that was reopened. |
reopenIssue
Reopen a issue.
Input fields forreopenIssue
input(ReopenIssueInput!)
Return fields forreopenIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was opened. |
reopenPullRequest
Reopen a pull request.
Input fields forreopenPullRequest
input(ReopenPullRequestInput!)
Return fields forreopenPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reopened. |
reorderEnvironment
Reorder a pinned repository environment.
Input fields forreorderEnvironment
input(ReorderEnvironmentInput!)
Return fields forreorderEnvironment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The environment that was reordered. |
replaceActorsForAssignable
Replaces all actors for assignable object.
Input fields forreplaceActorsForAssignable
input(ReplaceActorsForAssignableInput!)
Return fields forreplaceActorsForAssignable
| Name | Description |
|---|---|
| The item that was assigned. |
| A unique identifier for the client performing the mutation. |
reprioritizeSubIssue
Reprioritizes a sub-issue to a different position in the parent list.
Input fields forreprioritizeSubIssue
input(ReprioritizeSubIssueInput!)
Return fields forreprioritizeSubIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The parent issue that the sub-issue was reprioritized in. |
requestReviews
Set review requests on a pull request.
Input fields forrequestReviews
input(RequestReviewsInput!)
Return fields forrequestReviews
| 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 forrerequestCheckSuite
input(RerequestCheckSuiteInput!)
Return fields forrerequestCheckSuite
| Name | Description |
|---|---|
| The requested check suite. |
| A unique identifier for the client performing the mutation. |
resolveReviewThread
Marks a review thread as resolved.
Input fields forresolveReviewThread
input(ResolveReviewThreadInput!)
Return fields forresolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| 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 forretireSponsorsTier
input(RetireSponsorsTierInput!)
Return fields forretireSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was retired. |
revertPullRequest
Create a pull request that reverts the changes from a merged pull request.
Input fields forrevertPullRequest
input(RevertPullRequestInput!)
Return fields forrevertPullRequest
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reverted. |
| 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 forrevokeEnterpriseOrganizationsMigratorRole
Return fields forrevokeEnterpriseOrganizationsMigratorRole
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| 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 forrevokeMigratorRole
input(RevokeMigratorRoleInput!)
Return fields forrevokeMigratorRole
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
setEnterpriseIdentityProvider
Creates or updates the identity provider for an enterprise.
Input fields forsetEnterpriseIdentityProvider
Return fields forsetEnterpriseIdentityProvider
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The identity provider for the enterprise. |
setOrganizationInteractionLimit
Set an organization level interaction limit for an organization's public repositories.
Input fields forsetOrganizationInteractionLimit
Return fields forsetOrganizationInteractionLimit
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The organization that the interaction limit was set for. |
setRepositoryInteractionLimit
Sets an interaction limit setting for a repository.
Input fields forsetRepositoryInteractionLimit
Return fields forsetRepositoryInteractionLimit
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that the interaction limit was set for. |
setUserInteractionLimit
Set a user level interaction limit for an user's public repositories.
Input fields forsetUserInteractionLimit
input(SetUserInteractionLimitInput!)
Return fields forsetUserInteractionLimit
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that the interaction limit was set for. |
startOrganizationMigration
Starts a GitHub Enterprise Importer organization migration.
Input fields forstartOrganizationMigration
input(StartOrganizationMigrationInput!)
Return fields forstartOrganizationMigration
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new organization migration. |
startRepositoryMigration
Starts a GitHub Enterprise Importer (GEI) repository migration.
Input fields forstartRepositoryMigration
input(StartRepositoryMigrationInput!)
Return fields forstartRepositoryMigration
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository migration. |
submitPullRequestReview
Submits a pending pull request review.
Input fields forsubmitPullRequestReview
input(SubmitPullRequestReviewInput!)
Return fields forsubmitPullRequestReview
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The submitted pull request review. |
transferEnterpriseOrganization
Transfer an organization from one enterprise to another enterprise.
Input fields fortransferEnterpriseOrganization
Return fields fortransferEnterpriseOrganization
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The organization for which a transfer was initiated. |
transferIssue
Transfer an issue to a different repository.
Input fields fortransferIssue
input(TransferIssueInput!)
Return fields fortransferIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was transferred. |
unarchiveProjectV2Item
Unarchives a ProjectV2Item.
Input fields forunarchiveProjectV2Item
input(UnarchiveProjectV2ItemInput!)
Return fields forunarchiveProjectV2Item
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item unarchived from the project. |
unarchiveRepository
Unarchives a repository.
Input fields forunarchiveRepository
input(UnarchiveRepositoryInput!)
Return fields forunarchiveRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was unarchived. |
unfollowOrganization
Unfollow an organization.
Input fields forunfollowOrganization
input(UnfollowOrganizationInput!)
Return fields forunfollowOrganization
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The organization that was unfollowed. |
unfollowUser
Unfollow a user.
Input fields forunfollowUser
input(UnfollowUserInput!)
Return fields forunfollowUser
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was unfollowed. |
unlinkProjectV2FromRepository
Unlinks a project from a repository.
Input fields forunlinkProjectV2FromRepository
Return fields forunlinkProjectV2FromRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository the project is no longer linked to. |
unlinkProjectV2FromTeam
Unlinks a project to a team.
Input fields forunlinkProjectV2FromTeam
input(UnlinkProjectV2FromTeamInput!)
Return fields forunlinkProjectV2FromTeam
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team the project is unlinked from. |
unlinkRepositoryFromProject
Deletes a repository link from a project.
Warning
unlinkRepositoryFromProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forunlinkRepositoryFromProject
Return fields forunlinkRepositoryFromProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
unlockLockable
Unlock a lockable object.
Input fields forunlockLockable
input(UnlockLockableInput!)
Return fields forunlockLockable
| 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 forunmarkDiscussionCommentAsAnswer
Return fields forunmarkDiscussionCommentAsAnswer
| 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 forunmarkFileAsViewed
input(UnmarkFileAsViewedInput!)
Return fields forunmarkFileAsViewed
| 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 forunmarkIssueAsDuplicate
input(UnmarkIssueAsDuplicateInput!)
Return fields forunmarkIssueAsDuplicate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue or pull request that was marked as a duplicate. |
unmarkProjectV2AsTemplate
Unmark a project as a template.
Input fields forunmarkProjectV2AsTemplate
input(UnmarkProjectV2AsTemplateInput!)
Return fields forunmarkProjectV2AsTemplate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The project. |
unminimizeComment
Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.
Input fields forunminimizeComment
input(UnminimizeCommentInput!)
Return fields forunminimizeComment
| 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 forunpinIssue
input(UnpinIssueInput!)
Return fields forunpinIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The id of the pinned issue that was unpinned. |
| The issue that was unpinned. |
unresolveReviewThread
Marks a review thread as unresolved.
Input fields forunresolveReviewThread
input(UnresolveReviewThreadInput!)
Return fields forunresolveReviewThread
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
updateBranchProtectionRule
Update a branch protection rule.
Input fields forupdateBranchProtectionRule
input(UpdateBranchProtectionRuleInput!)
Return fields forupdateBranchProtectionRule
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
updateCheckRun
Update a check run.
Input fields forupdateCheckRun
input(UpdateCheckRunInput!)
Return fields forupdateCheckRun
| 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 forupdateCheckSuitePreferences
Return fields forupdateCheckSuitePreferences
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateDiscussion
Update a discussion.
Input fields forupdateDiscussion
input(UpdateDiscussionInput!)
Return fields forupdateDiscussion
| 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 forupdateDiscussionComment
input(UpdateDiscussionCommentInput!)
Return fields forupdateDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The modified discussion comment. |
updateEnterpriseAdministratorRole
Updates the role of an enterprise administrator.
updateEnterpriseAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an enterprise.
Input fields forupdateEnterpriseAllowPrivateRepositoryForkingSetting
Return fields forupdateEnterpriseAllowPrivateRepositoryForkingSetting
| 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 forupdateEnterpriseDefaultRepositoryPermissionSetting
Return fields forupdateEnterpriseDefaultRepositoryPermissionSetting
| 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. |
updateEnterpriseDeployKeySetting
Sets whether deploy keys are allowed to be created and used for an enterprise.
Input fields forupdateEnterpriseDeployKeySetting
Return fields forupdateEnterpriseDeployKeySetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated deploy key setting. |
| A message confirming the result of updating the deploy key setting. |
updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Sets whether organization members with admin permissions on a repository can change repository visibility.
Input fields forupdateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Return fields forupdateEnterpriseMembersCanChangeRepositoryVisibilitySetting
| 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 forupdateEnterpriseMembersCanCreateRepositoriesSetting
Return fields forupdateEnterpriseMembersCanCreateRepositoriesSetting
| 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 forupdateEnterpriseMembersCanDeleteIssuesSetting
Return fields forupdateEnterpriseMembersCanDeleteIssuesSetting
| 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 forupdateEnterpriseMembersCanDeleteRepositoriesSetting
Return fields forupdateEnterpriseMembersCanDeleteRepositoriesSetting
| 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 forupdateEnterpriseMembersCanInviteCollaboratorsSetting
Return fields forupdateEnterpriseMembersCanInviteCollaboratorsSetting
| 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 owner can make purchases.
Input fields forupdateEnterpriseMembersCanMakePurchasesSetting
Return fields forupdateEnterpriseMembersCanMakePurchasesSetting
| 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 forupdateEnterpriseMembersCanUpdateProtectedBranchesSetting
Return fields forupdateEnterpriseMembersCanUpdateProtectedBranchesSetting
| 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 forupdateEnterpriseMembersCanViewDependencyInsightsSetting
Return fields forupdateEnterpriseMembersCanViewDependencyInsightsSetting
| 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 forupdateEnterpriseOrganizationProjectsSetting
Return fields forupdateEnterpriseOrganizationProjectsSetting
| 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. |
updateEnterpriseOwnerOrganizationRole
Updates the role of an enterprise owner with an organization.
updateEnterpriseProfile
Updates an enterprise's profile.
Input fields forupdateEnterpriseProfile
input(UpdateEnterpriseProfileInput!)
Return fields forupdateEnterpriseProfile
| 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 forupdateEnterpriseRepositoryProjectsSetting
Return fields forupdateEnterpriseRepositoryProjectsSetting
| 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 forupdateEnterpriseTeamDiscussionsSetting
Return fields forupdateEnterpriseTeamDiscussionsSetting
| 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. |
updateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting
Sets the two-factor authentication methods that users of an enterprise may not use.
Input fields forupdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting
Return fields forupdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated two-factor authentication disallowed methods setting. |
| A message confirming the result of updating the two-factor authentication disallowed methods setting. |
updateEnterpriseTwoFactorAuthenticationRequiredSetting
Sets whether two factor authentication is required for all users in an enterprise.
Input fields forupdateEnterpriseTwoFactorAuthenticationRequiredSetting
Return fields forupdateEnterpriseTwoFactorAuthenticationRequiredSetting
| 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 forupdateEnvironment
input(UpdateEnvironmentInput!)
Return fields forupdateEnvironment
| 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 forupdateIpAllowListEnabledSetting
Return fields forupdateIpAllowListEnabledSetting
| 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 forupdateIpAllowListEntry
input(UpdateIpAllowListEntryInput!)
Return fields forupdateIpAllowListEntry
| 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 forupdateIpAllowListForInstalledAppsEnabledSetting
Return fields forupdateIpAllowListForInstalledAppsEnabledSetting
| 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 forupdateIssue
input(UpdateIssueInput!)
Return fields forupdateIssue
| 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 forupdateIssueComment
input(UpdateIssueCommentInput!)
Return fields forupdateIssueComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateIssueIssueType
Updates the issue type on an issue.
Input fields forupdateIssueIssueType
input(UpdateIssueIssueTypeInput!)
Return fields forupdateIssueIssueType
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated issue. |
updateIssueType
Update an issue type.
Input fields forupdateIssueType
input(UpdateIssueTypeInput!)
Return fields forupdateIssueType
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated issue type. |
updateLabel
Updates an existing label.
Input fields forupdateLabel
input(UpdateLabelInput!)
Return fields forupdateLabel
| 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 forupdateNotificationRestrictionSetting
Return fields forupdateNotificationRestrictionSetting
| 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 forupdateOrganizationAllowPrivateRepositoryForkingSetting
Return fields forupdateOrganizationAllowPrivateRepositoryForkingSetting
| 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. |
updateOrganizationWebCommitSignoffSetting
Sets whether contributors are required to sign off on web-based commits for repositories in an organization.
Input fields forupdateOrganizationWebCommitSignoffSetting
Return fields forupdateOrganizationWebCommitSignoffSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A message confirming the result of updating the web commit signoff setting. |
| The organization with the updated web commit signoff setting. |
updatePatreonSponsorability
Toggle the setting for your GitHub Sponsors profile that allows other GitHubaccounts to sponsor you on GitHub while paying for the sponsorship on Patreon.Only applicable when you have a GitHub Sponsors profile and have connectedyour GitHub account with Patreon.
Input fields forupdatePatreonSponsorability
Return fields forupdatePatreonSponsorability
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The GitHub Sponsors profile. |
updateProject
Updates an existing project.
Warning
updateProject is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forupdateProject
input(UpdateProjectInput!)
Return fields forupdateProject
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project. |
updateProjectCard
Updates an existing project card.
Warning
updateProjectCard is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forupdateProjectCard
input(UpdateProjectCardInput!)
Return fields forupdateProjectCard
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
updateProjectColumn
Updates an existing project column.
Warning
updateProjectColumn is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see:https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields forupdateProjectColumn
input(UpdateProjectColumnInput!)
Return fields forupdateProjectColumn
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project column. |
updateProjectV2
Updates an existing project.
Input fields forupdateProjectV2
input(UpdateProjectV2Input!)
Return fields forupdateProjectV2
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated Project. |
updateProjectV2Collaborators
Update the collaborators on a team or a project.
Input fields forupdateProjectV2Collaborators
Return fields forupdateProjectV2Collaborators
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The collaborators granted a role. |
updateProjectV2DraftIssue
Updates a draft issue within a Project.
Input fields forupdateProjectV2DraftIssue
input(UpdateProjectV2DraftIssueInput!)
Return fields forupdateProjectV2DraftIssue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The draft issue updated in the project. |
updateProjectV2Field
Update a project field.
Input fields forupdateProjectV2Field
input(UpdateProjectV2FieldInput!)
Return fields forupdateProjectV2Field
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated field. |
updateProjectV2ItemFieldValue
This mutation updates the value of a field for an item in a Project. Currentlyonly single-select, text, number, date, and iteration fields are supported.
Input fields forupdateProjectV2ItemFieldValue
Return fields forupdateProjectV2ItemFieldValue
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| 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 forupdateProjectV2ItemPosition
Return fields forupdateProjectV2ItemPosition
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The items in the new order. |
updateProjectV2StatusUpdate
Updates a status update within a Project.
Input fields forupdateProjectV2StatusUpdate
Return fields forupdateProjectV2StatusUpdate
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The status update updated in the project. |
updatePullRequest
Update a pull request.
Input fields forupdatePullRequest
input(UpdatePullRequestInput!)
Return fields forupdatePullRequest
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestBranch
Merge or Rebase HEAD from upstream branch into pull request branch.
Input fields forupdatePullRequestBranch
input(UpdatePullRequestBranchInput!)
Return fields forupdatePullRequestBranch
| 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 forupdatePullRequestReview
input(UpdatePullRequestReviewInput!)
Return fields forupdatePullRequestReview
| 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 forupdatePullRequestReviewComment
Return fields forupdatePullRequestReviewComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateRef
Update a Git Ref.
Input fields forupdateRef
input(UpdateRefInput!)
Return fields forupdateRef
| 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 ofRefUpdates and performs these updateson the repository. All updates are performed atomically, meaning thatif one of them is rejected, no other ref will be modified.
RefUpdate.beforeOid specifies that the given reference needs to pointto the given value before performing any updates. A value of0000000000000000000000000000000000000000 can be used to verify thatthe references should not exist.
RefUpdate.afterOid specifies the value that the given referencewill point to after performing all updates. A value of0000000000000000000000000000000000000000 can be used to delete areference.
IfRefUpdate.force is set totrue, a non-fast-forward updatesfor the given reference will be allowed.
Input fields forupdateRefs
input(UpdateRefsInput!)
Return fields forupdateRefs
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
updateRepository
Update information about a repository.
Input fields forupdateRepository
input(UpdateRepositoryInput!)
Return fields forupdateRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateRepositoryRuleset
Update a repository ruleset.
Input fields forupdateRepositoryRuleset
input(UpdateRepositoryRulesetInput!)
Return fields forupdateRepositoryRuleset
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created Ruleset. |
updateRepositoryWebCommitSignoffSetting
Sets whether contributors are required to sign off on web-based commits for a repository.
Input fields forupdateRepositoryWebCommitSignoffSetting
Return fields forupdateRepositoryWebCommitSignoffSetting
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A message confirming the result of updating the web commit signoff setting. |
| The updated repository. |
updateSponsorshipPreferences
Change visibility of your sponsorship and opt in or out of email updates from the maintainer.
Input fields forupdateSponsorshipPreferences
Return fields forupdateSponsorshipPreferences
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The sponsorship that was updated. |
updateSubscription
Updates the state for subscribable subjects.
Input fields forupdateSubscription
input(UpdateSubscriptionInput!)
Return fields forupdateSubscription
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The input subscribable entity. |
updateTeamDiscussion
Updates a team discussion.
Input fields forupdateTeamDiscussion
input(UpdateTeamDiscussionInput!)
Return fields forupdateTeamDiscussion
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated discussion. |
updateTeamDiscussionComment
Updates a discussion comment.
Input fields forupdateTeamDiscussionComment
Return fields forupdateTeamDiscussionComment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateTeamReviewAssignment
Updates team review assignment.
Input fields forupdateTeamReviewAssignment
input(UpdateTeamReviewAssignmentInput!)
Return fields forupdateTeamReviewAssignment
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team that was modified. |
updateTeamsRepository
Update team repository.
Input fields forupdateTeamsRepository
input(UpdateTeamsRepositoryInput!)
Return fields forupdateTeamsRepository
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was updated. |
| The teams granted permission on the repository. |
updateTopics
Replaces the repository's topics with the given topics.
Input fields forupdateTopics
input(UpdateTopicsInput!)
Return fields forupdateTopics
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Names of the provided topics that are not valid. |
| The updated repository. |
updateUserList
Updates an existing user list.
Input fields forupdateUserList
input(UpdateUserListInput!)
Return fields forupdateUserList
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The list that was just updated. |
updateUserListsForItem
Updates which of the viewer's lists an item belongs to.
Input fields forupdateUserListsForItem
input(UpdateUserListsForItemInput!)
Return fields forupdateUserListsForItem
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was added. |
| The lists to which this item belongs. |
| The user who owns the lists. |
verifyVerifiableDomain
Verify that a verifiable domain has the expected DNS record.
Input fields forverifyVerifiableDomain
input(VerifyVerifiableDomainInput!)
Return fields forverifyVerifiableDomain
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was verified. |