Mutations

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

acceptEnterpriseAdministratorInvitation

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

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The accepted topic.


addAssigneesToAssignable

Adds assignees to an assignable object.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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.


addLabelsToLabelable

Adds labels to a labelable object.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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.


addPullRequestReview

Adds a review to a Pull Request.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.


addReaction

Adds a reaction to a subject.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


addStar

Adds a star to a Starrable.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


archiveRepository

Marks a repository as archived.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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.


changeUserStatus

Update your status on GitHub.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.


cloneProject

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

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


closeIssue

Close an issue.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


createBranchProtectionRule

Create a new branch protection rule.

Input fields

Return fields

Name Description

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckRun

Create a check run.

Input fields

Return fields

Name Description

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

Return fields

Name Description

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createContentAttachment

Create a content attachment.

Preview notice

createContentAttachment is available under the Create content attachments preview. During the preview period, the API may change without notice.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentAttachment (ContentAttachment)

The newly created content attachment.


createDeployment

Creates a new deployment event.

Preview notice

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

Input fields

Return fields

Name Description

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.

Preview notice

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

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.


createEnterpriseOrganization

Creates an organization as part of an enterprise account.

Input fields

Return fields

Name Description

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.


createIpAllowListEntry

Creates a new IP allow list entry.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.


createLabel

Creates a new label.

Preview notice

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

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.


createProject

Creates a new project.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.


createPullRequest

Create a new pull request.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.


createRepository

Create a new repository.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


createTeamDiscussion

Creates a new team discussion.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.


createTeamDiscussionComment

Creates a new team discussion comment.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.


declineTopicSuggestion

Rejects a suggested topic for the repository.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

topic (Topic)

The declined topic.


deleteBranchProtectionRule

Delete a branch protection rule.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteDeployment

Deletes a deployment.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteIpAllowListEntry

Deletes an IP allow list entry.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteLabel

Deletes a label.

Preview notice

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

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deletePackageVersion

Delete a package version.

Preview notice

deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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.


deletePullRequestReview

Deletes a pull request review.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.


deleteRef

Delete a Git Ref.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussion

Deletes a team discussion.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussionComment

Deletes a team discussion comment.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


dismissPullRequestReview

Dismisses an approved or rejected pull request review.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.


followUser

Follow a user.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.


importProject

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

Preview notice

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

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The created enterprise administrator invitation.


linkRepositoryToProject

Creates a repository link for a project.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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.


markFileAsViewed

Mark a pull request file as viewed.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.


markPullRequestReadyForReview

Marks a pull request ready for review.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.


mergePullRequest

Merge a pull request.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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.

Preview notice

pinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.


regenerateEnterpriseIdentityProviderRecoveryCodes

Regenerates the identity provider recovery codes for an enterprise.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.


removeAssigneesFromAssignable

Removes assignees from an assignable object.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider that was removed from the enterprise.


removeEnterpriseOrganization

Removes an organization from the enterprise.

Input fields

Return fields

Name Description

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.


removeLabelsFromLabelable

Removes labels from a Labelable object.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


removeStar

Removes a star from a Starrable.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


reopenIssue

Reopen a issue.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


setEnterpriseIdentityProvider

Creates or updates the identity provider for an enterprise.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.


submitPullRequestReview

Submits a pending pull request review.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.


transferIssue

Transfer an issue to a different repository.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.


unarchiveRepository

Unarchives a repository.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.


unfollowUser

Unfollow a user.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.


unlinkRepositoryFromProject

Deletes a repository link from a project.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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.


unmarkFileAsViewed

Unmark a pull request file as viewed.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

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


unminimizeComment

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

Input fields

Return fields

Name Description

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.

Preview notice

unpinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was unpinned.


unresolveReviewThread

Marks a review thread as unresolved.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


updateBranchProtectionRule

Create a new branch protection rule.

Input fields

Return fields

Name Description

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckRun

Update a check run.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateEnterpriseAdministratorRole

Updates the role of an enterprise administrator.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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 default repository permission for organizations in an enterprise.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated default repository permission setting.

message (String)

A message confirming the result of updating the default repository permission setting.


updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Sets whether organization members with admin permissions on a repository can change repository visibility.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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 admin can make purchases.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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.


updateEnterpriseProfile

Updates an enterprise's profile.

Input fields

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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

Return fields

Name Description

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.


updateIpAllowListEnabledSetting

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

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was updated.


updateIssue

Updates an Issue.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.


updateLabel

Updates an existing label.

Preview notice

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

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.


updateProject

Updates an existing project.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.


updateProjectCard

Updates an existing project card.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


updateProjectColumn

Updates an existing project column.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.


updatePullRequest

Update a pull request.

Input fields

Return fields

Name Description

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.


updatePullRequestReview

Updates the body of a pull request review.

Input fields

Return fields

Name Description

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

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.


updateRef

Update a Git Ref.

Input fields

Return fields

Name Description

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.

Preview notice

updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateRepository

Update information about a repository.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateSubscription

Updates the state for subscribable subjects.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.


updateTeamDiscussion

Updates a team discussion.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.


updateTeamDiscussionComment

Updates a discussion comment.

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.


updateTeamReviewAssignment

Updates team review assignment.

Preview notice

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

Input fields

Return fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.


updateTopics

Replaces the repository's topics with the given topics.

Input fields

Return fields

Name Description

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.


Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.