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."
addAssigneesToAssignable
Adds assignees to an assignable object.
Input fields
input(AddAssigneesToAssignableInput!)
Return fields
| 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
input(AddCommentInput!)
Return fields
| 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
input(AddDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created discussion comment. |
addEnterpriseAdmin
Adds an administrator to the global enterprise account.
Input fields
input(AddEnterpriseAdminInput!)
Return fields
| Name | Description |
|---|---|
| The user who was added as an administrator. |
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| The role of the administrator. |
| The viewer performing the mutation. |
addLabelsToLabelable
Adds labels to a labelable object.
Input fields
input(AddLabelsToLabelableInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was labeled. |
addProjectCard
Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.
Input fields
input(AddProjectCardInput!)
Return fields
| Name | Description |
|---|---|
| The edge from the ProjectColumn's card connection. |
| A unique identifier for the client performing the mutation. |
| The ProjectColumn. |
addProjectColumn
Adds a column to a Project.
Input fields
input(AddProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The edge from the project's column connection. |
| The project. |
addPullRequestReview
Adds a review to a Pull Request.
Input fields
input(AddPullRequestReviewInput!)
Return fields
| 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
Return fields
| 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
input(AddPullRequestReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created thread. |
addReaction
Adds a reaction to a subject.
Input fields
input(AddReactionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reactable subject. |
addStar
Adds a star to a Starrable.
Input fields
input(AddStarInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
addUpvote
Add an upvote to a discussion or discussion comment.
Input fields
input(AddUpvoteInput!)
Return fields
| 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
input(AddVerifiableDomainInput!)
Return fields
| 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
input(ApproveDeploymentsInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
approveVerifiableDomain
Approve a verifiable domain for notification delivery.
Input fields
input(ApproveVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was approved. |
archiveRepository
Marks a repository as archived.
Input fields
input(ArchiveRepositoryInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was marked as archived. |
changeUserStatus
Update your status on GitHub.
Input fields
input(ChangeUserStatusInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Your updated status. |
clearLabelsFromLabelable
Clears all labels from a labelable object.
Input fields
input(ClearLabelsFromLabelableInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item that was unlabeled. |
cloneProject
Creates a new project by cloning configuration from an existing project.
Input fields
input(CloneProjectInput!)
Return fields
| 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
input(CloneTemplateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
closeIssue
Close an issue.
Input fields
input(CloseIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was closed. |
closePullRequest
Close a pull request.
Input fields
input(ClosePullRequestInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was closed. |
convertProjectCardNoteToIssue
Convert a project note card to one associated with a newly created issue.
Input fields
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
convertPullRequestToDraft
Converts a pull request to draft.
Input fields
input(ConvertPullRequestToDraftInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is now a draft. |
createBranchProtectionRule
Create a new branch protection rule.
Input fields
input(CreateBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
createCheckRun
Create a check run.
Input fields
input(CreateCheckRunInput!)
Return fields
| Name | Description |
|---|---|
| The newly created check run. |
| A unique identifier for the client performing the mutation. |
createCheckSuite
Create a check suite.
Input fields
input(CreateCheckSuiteInput!)
Return fields
| Name | Description |
|---|---|
| The newly created check suite. |
| 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
input(CreateContentAttachmentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| 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
input(CreateDeploymentInput!)
Return fields
| Name | Description |
|---|---|
| True if the default branch has been auto-merged into the deployment ref. |
| A unique identifier for the client performing the mutation. |
| The new deployment. |
createDeploymentStatus
Create a deployment status.
Preview notice
createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields
input(CreateDeploymentStatusInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new deployment status. |
createDiscussion
Create a discussion.
Input fields
input(CreateDiscussionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion that was just created. |
createEnterpriseOrganization
Creates an organization as part of an enterprise account.
Input fields
Return fields
| 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
input(CreateEnvironmentInput!)
Return fields
| 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
input(CreateIpAllowListEntryInput!)
Return fields
| 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
input(CreateIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new issue. |
createLabel
Creates a new label.
Preview notice
createLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(CreateLabelInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new label. |
createProject
Creates a new project.
Input fields
input(CreateProjectInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new project. |
createPullRequest
Create a new pull request.
Input fields
input(CreatePullRequestInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new pull request. |
createRef
Create a new Git Ref.
Input fields
input(CreateRefInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created ref. |
createRepository
Create a new repository.
Input fields
input(CreateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new repository. |
createTeamDiscussion
Creates a new team discussion.
Input fields
input(CreateTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new discussion. |
createTeamDiscussionComment
Creates a new team discussion comment.
Input fields
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new comment. |
deleteBranchProtectionRule
Delete a branch protection rule.
Input fields
input(DeleteBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDeployment
Deletes a deployment.
Input fields
input(DeleteDeploymentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteDiscussion
Delete a discussion and all of its replies.
Input fields
input(DeleteDiscussionInput!)
Return fields
| 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
input(DeleteDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The discussion comment that was just deleted. |
deleteEnvironment
Deletes an environment.
Input fields
input(DeleteEnvironmentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteIpAllowListEntry
Deletes an IP allow list entry.
Input fields
input(DeleteIpAllowListEntryInput!)
Return fields
| 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
input(DeleteIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository the issue belonged to. |
deleteIssueComment
Deletes an IssueComment object.
Input fields
input(DeleteIssueCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteLabel
Deletes a label.
Preview notice
deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(DeleteLabelInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deletePackageVersion
Delete a package version.
Preview notice
deletePackageVersion is available under the Access to package version deletion preview. During the preview period, the API may change without notice.
Input fields
input(DeletePackageVersionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether or not the operation succeeded. |
deleteProject
Deletes a project.
Input fields
input(DeleteProjectInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository or organization the project was removed from. |
deleteProjectCard
Deletes a project card.
Input fields
input(DeleteProjectCardInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The column the deleted card was in. |
| The deleted card ID. |
deleteProjectColumn
Deletes a project column.
Input fields
input(DeleteProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted column ID. |
| The project the deleted column was in. |
deletePullRequestReview
Deletes a pull request review.
Input fields
input(DeletePullRequestReviewInput!)
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request review the deleted comment belonged to. |
deleteRef
Delete a Git Ref.
Input fields
input(DeleteRefInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussion
Deletes a team discussion.
Input fields
input(DeleteTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteTeamDiscussionComment
Deletes a team discussion comment.
Input fields
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteVerifiableDomain
Deletes a verifiable domain.
Input fields
input(DeleteVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owning account from which the domain was deleted. |
disablePullRequestAutoMerge
Disable auto merge on the given pull request.
Input fields
Return fields
| 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
input(DismissPullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The dismissed pull request review. |
enablePullRequestAutoMerge
Enable the default auto-merge on a pull request.
Input fields
input(EnablePullRequestAutoMergeInput!)
Return fields
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request auto-merge was enabled on. |
followUser
Follow a user.
Input fields
input(FollowUserInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was followed. |
importProject
Creates a new project by importing columns and a list of issues/PRs.
Preview notice
importProject is available under the Import project preview. During the preview period, the API may change without notice.
Input fields
input(ImportProjectInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new Project!. |
linkRepositoryToProject
Creates a repository link for a project.
Input fields
input(LinkRepositoryToProjectInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
lockLockable
Lock a lockable object.
Input fields
input(LockLockableInput!)
Return fields
| 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
Return fields
| 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
input(MarkFileAsViewedInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Input fields
Return fields
| 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
input(MergeBranchInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The resulting merge Commit. |
mergePullRequest
Merge a pull request.
Input fields
input(MergePullRequestInput!)
Return fields
| 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
input(MinimizeCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The comment that was minimized. |
moveProjectCard
Moves a project card to another place.
Input fields
input(MoveProjectCardInput!)
Return fields
| Name | Description |
|---|---|
| The new edge of the moved card. |
| A unique identifier for the client performing the mutation. |
moveProjectColumn
Moves a project column to another place.
Input fields
input(MoveProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new edge of the moved column. |
pinIssue
Pin an issue to a repository.
Input fields
input(PinIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was pinned. |
regenerateVerifiableDomainToken
Regenerates a verifiable domain's verification token.
rejectDeployments
Reject all pending deployments under one or more environments.
Input fields
input(RejectDeploymentsInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
removeAssigneesFromAssignable
Removes assignees from an assignable object.
Input fields
Return fields
| 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
input(RemoveEnterpriseAdminInput!)
Return fields
| Name | Description |
|---|---|
| The user who was removed as an administrator. |
| A unique identifier for the client performing the mutation. |
| The updated enterprise. |
| A message confirming the result of removing an administrator. |
| The viewer performing the mutation. |
removeLabelsFromLabelable
Removes labels from a Labelable object.
Input fields
input(RemoveLabelsFromLabelableInput!)
Return fields
| 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
input(RemoveOutsideCollaboratorInput!)
Return fields
| 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
input(RemoveReactionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reaction object. |
| The reactable subject. |
removeStar
Removes a star from a Starrable.
Input fields
input(RemoveStarInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The starrable. |
removeUpvote
Remove an upvote to a discussion or discussion comment.
Input fields
input(RemoveUpvoteInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The votable subject. |
reopenIssue
Reopen a issue.
Input fields
input(ReopenIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was opened. |
reopenPullRequest
Reopen a pull request.
Input fields
input(ReopenPullRequestInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reopened. |
requestReviews
Set review requests on a pull request.
Input fields
input(RequestReviewsInput!)
Return fields
| 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
input(RerequestCheckSuiteInput!)
Return fields
| Name | Description |
|---|---|
| The requested check suite. |
| A unique identifier for the client performing the mutation. |
resolveReviewThread
Marks a review thread as resolved.
Input fields
input(ResolveReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
submitPullRequestReview
Submits a pending pull request review.
Input fields
input(SubmitPullRequestReviewInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The submitted pull request review. |
transferIssue
Transfer an issue to a different repository.
Input fields
input(TransferIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was transferred. |
unarchiveRepository
Unarchives a repository.
Input fields
input(UnarchiveRepositoryInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The repository that was unarchived. |
unfollowUser
Unfollow a user.
Input fields
input(UnfollowUserInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The user that was unfollowed. |
unlinkRepositoryFromProject
Deletes a repository link from a project.
Input fields
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The linked Project. |
| The linked Repository. |
unlockLockable
Unlock a lockable object.
Input fields
input(UnlockLockableInput!)
Return fields
| 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
Return fields
| 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
input(UnmarkFileAsViewedInput!)
Return fields
| 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
input(UnmarkIssueAsDuplicateInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue or pull request that was marked as a duplicate. |
unminimizeComment
Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.
Input fields
input(UnminimizeCommentInput!)
Return fields
| 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
input(UnpinIssueInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The issue that was unpinned. |
unresolveReviewThread
Marks a review thread as unresolved.
Input fields
input(UnresolveReviewThreadInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
updateBranchProtectionRule
Create a new branch protection rule.
Input fields
input(UpdateBranchProtectionRuleInput!)
Return fields
| Name | Description |
|---|---|
| The newly created BranchProtectionRule. |
| A unique identifier for the client performing the mutation. |
updateCheckRun
Update a check run.
Input fields
input(UpdateCheckRunInput!)
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateDiscussion
Update a discussion.
Input fields
input(UpdateDiscussionInput!)
Return fields
| 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
input(UpdateDiscussionCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The modified discussion comment. |
updateEnterpriseAllowPrivateRepositoryForkingSetting
Sets whether private repository forks are enabled for an enterprise.
Input fields
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated base repository permission setting. |
| A message confirming the result of updating the base repository permission setting. |
updateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Sets whether organization members with admin permissions on a repository can change repository visibility.
Input fields
Return fields
| 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
Return fields
| 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
Return fields
| 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
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated members can invite collaborators setting. |
| A message confirming the result of updating the members can invite collaborators setting. |
updateEnterpriseMembersCanMakePurchasesSetting
Sets whether or not an organization admin can make purchases.
Input fields
Return fields
| 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
Return fields
| 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
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated organization projects setting. |
| A message confirming the result of updating the organization projects setting. |
updateEnterpriseProfile
Updates an enterprise's profile.
Input fields
input(UpdateEnterpriseProfileInput!)
Return fields
| 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
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The enterprise with the updated team discussions setting. |
| A message confirming the result of updating the team discussions setting. |
updateEnterpriseTwoFactorAuthenticationRequiredSetting
Sets whether two factor authentication is required for all users in an enterprise.
Input fields
Return fields
| 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
input(UpdateEnvironmentInput!)
Return fields
| 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
Return fields
| 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
input(UpdateIpAllowListEntryInput!)
Return fields
| 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
Return fields
| 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
input(UpdateIssueInput!)
Return fields
| 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
input(UpdateIssueCommentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateLabel
Updates an existing label.
Preview notice
updateLabel is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
input(UpdateLabelInput!)
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owner on which the setting was updated. |
updateProject
Updates an existing project.
Input fields
input(UpdateProjectInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project. |
updateProjectCard
Updates an existing project card.
Input fields
input(UpdateProjectCardInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated ProjectCard. |
updateProjectColumn
Updates an existing project column.
Input fields
input(UpdateProjectColumnInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated project column. |
updatePullRequest
Update a pull request.
Input fields
input(UpdatePullRequestInput!)
Return fields
| Name | Description |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestReview
Updates the body of a pull request review.
Input fields
input(UpdatePullRequestReviewInput!)
Return fields
| 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
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateRef
Update a Git Ref.
Input fields
input(UpdateRefInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated Ref. |
updateRefs
Creates, updates and/or deletes multiple refs in a repository.
This mutation takes a list of RefUpdates and performs these updates
on the repository. All updates are performed atomically, meaning that
if one of them is rejected, no other ref will be modified.
RefUpdate.beforeOid specifies that the given reference needs to point
to the given value before performing any updates. A value of
0000000000000000000000000000000000000000 can be used to verify that
the references should not exist.
RefUpdate.afterOid specifies the value that the given reference
will point to after performing all updates. A value of
0000000000000000000000000000000000000000 can be used to delete a
reference.
If RefUpdate.force is set to true, a non-fast-forward updates
for the given reference will be allowed.
Preview notice
updateRefs is available under the Update refs preview. During the preview period, the API may change without notice.
Input fields
input(UpdateRefsInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
updateRepository
Update information about a repository.
Input fields
input(UpdateRepositoryInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated repository. |
updateSubscription
Updates the state for subscribable subjects.
Input fields
input(UpdateSubscriptionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The input subscribable entity. |
updateTeamDiscussion
Updates a team discussion.
Input fields
input(UpdateTeamDiscussionInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated discussion. |
updateTeamDiscussionComment
Updates a discussion comment.
Input fields
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateTeamReviewAssignment
Updates team review assignment.
Preview notice
updateTeamReviewAssignment is available under the Team review assignments preview. During the preview period, the API may change without notice.
Input fields
input(UpdateTeamReviewAssignmentInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team that was modified. |
updateTopics
Replaces the repository's topics with the given topics.
Input fields
input(UpdateTopicsInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Names of the provided topics that are not valid. |
| The updated repository. |
verifyVerifiableDomain
Verify that a verifiable domain has the expected DNS record.
Input fields
input(VerifyVerifiableDomainInput!)
Return fields
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The verifiable domain that was verified. |