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. |
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. |
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. |
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. |
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.
Preview notice
createCheckRun
is available under the Checks preview. During the preview period, the API may change without notice.
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.
Preview notice
createCheckSuite
is available under the Checks preview. During the preview period, the API may change without notice.
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. |
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.
Preview notice
createTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
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.
Preview notice
createTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
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. |
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. |
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.
Preview notice
deleteTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
Input fields
input
(DeleteTeamDiscussionInput!
)
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteTeamDiscussionComment
Deletes a team discussion comment.
Preview notice
deleteTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
Input fields
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
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. |
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!. |
lockLockable
Lock a lockable object.
Input fields
input
(LockLockableInput!
)
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was locked. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Preview notice
markPullRequestReadyForReview
is available under the Draft pull requests preview. During the preview period, the API may change without notice.
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 |
---|---|
|
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.
Preview notice
minimizeComment
is available under the Minimize comments preview. During the preview period, the API may change without notice.
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.
Preview notice
pinIssue
is available under the Pinned issues preview. During the preview period, the API may change without notice.
Input fields
input
(PinIssueInput!
)
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was pinned. |
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. |
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. |
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 |
---|---|
|
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.
Preview notice
rerequestCheckSuite
is available under the Checks preview. During the preview period, the API may change without notice.
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. |
unlockLockable
Unlock a lockable object.
Input fields
input
(UnlockLockableInput!
)
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was unlocked. |
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.
Preview notice
unminimizeComment
is available under the Minimize comments preview. During the preview period, the API may change without notice.
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.
Preview notice
unpinIssue
is available under the Pinned issues preview. During the preview period, the API may change without notice.
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.
Preview notice
updateCheckRun
is available under the Checks preview. During the preview period, the API may change without notice.
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.
Preview notice
updateCheckSuitePreferences
is available under the Checks preview. During the preview period, the API may change without notice.
Input fields
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated repository. |
updateIssue
Updates an Issue.
Input fields
input
(UpdateIssueInput!
)
Return fields
Name | Description |
---|---|
|
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. |
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 |
---|---|
|
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. |
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.
Preview notice
updateTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
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.
Preview notice
updateTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
Input fields
Return fields
Name | Description |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
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. |