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.
Campos de entrada
input
(AddAssigneesToAssignableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The item that was assigned. |
|
A unique identifier for the client performing the mutation. |
addComment
Adds a comment to an Issue or Pull Request.
Campos de entrada
input
(AddCommentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(AddLabelsToLabelableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(AddProjectCardInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(AddProjectColumnInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(AddPullRequestReviewInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(AddReactionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The reaction object. |
|
The reactable subject. |
addStar
Adds a star to a Starrable.
Campos de entrada
input
(AddStarInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The starrable. |
changeUserStatus
Update your status on GitHub.
Campos de entrada
input
(ChangeUserStatusInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
Your updated status. |
clearLabelsFromLabelable
Clears all labels from a labelable object.
Campos de entrada
input
(ClearLabelsFromLabelableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(CloneProjectInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(CloneTemplateRepositoryInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new repository. |
closeIssue
Close an issue.
Campos de entrada
input
(CloseIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was closed. |
closePullRequest
Close a pull request.
Campos de entrada
input
(ClosePullRequestInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated ProjectCard. |
createBranchProtectionRule
Create a new branch protection rule.
Campos de entrada
input
(CreateBranchProtectionRuleInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The newly created BranchProtectionRule. |
|
A unique identifier for the client performing the mutation. |
createCheckRun
Create a check run.
Aviso de pré-visualização
createCheckRun
is available under the Checks preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateCheckRunInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The newly created check run. |
|
A unique identifier for the client performing the mutation. |
createCheckSuite
Create a check suite.
Aviso de pré-visualização
createCheckSuite
is available under the Checks preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateCheckSuiteInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The newly created check suite. |
|
A unique identifier for the client performing the mutation. |
createContentAttachment
Create a content attachment.
Aviso de pré-visualização
createContentAttachment
is available under the Create content attachments preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateContentAttachmentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created content attachment. |
createDeployment
Creates a new deployment event.
Aviso de pré-visualização
createDeployment
is available under the Deployments preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateDeploymentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Aviso de pré-visualização
createDeploymentStatus
is available under the Deployments preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateDeploymentStatusInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new deployment status. |
createIssue
Creates a new issue.
Campos de entrada
input
(CreateIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new issue. |
createLabel
Creates a new label.
Aviso de pré-visualização
createLabel
is available under the Labels preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateLabelInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new label. |
createProject
Creates a new project.
Campos de entrada
input
(CreateProjectInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new project. |
createPullRequest
Create a new pull request.
Campos de entrada
input
(CreatePullRequestInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new pull request. |
createRef
Create a new Git Ref.
Campos de entrada
input
(CreateRefInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The newly created ref. |
createRepository
Create a new repository.
Campos de entrada
input
(CreateRepositoryInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new repository. |
createTeamDiscussion
Creates a new team discussion.
Aviso de pré-visualização
createTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
input
(CreateTeamDiscussionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new discussion. |
createTeamDiscussionComment
Creates a new team discussion comment.
Aviso de pré-visualização
createTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new comment. |
deleteBranchProtectionRule
Delete a branch protection rule.
Campos de entrada
input
(DeleteBranchProtectionRuleInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteIssue
Deletes an Issue object.
Campos de entrada
input
(DeleteIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository the issue belonged to. |
deleteIssueComment
Deletes an IssueComment object.
Campos de entrada
input
(DeleteIssueCommentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteLabel
Deletes a label.
Aviso de pré-visualização
deleteLabel
is available under the Labels preview. During the preview period, the API may change without notice.
Campos de entrada
input
(DeleteLabelInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteProject
Deletes a project.
Campos de entrada
input
(DeleteProjectInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The repository or organization the project was removed from. |
deleteProjectCard
Deletes a project card.
Campos de entrada
input
(DeleteProjectCardInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(DeleteProjectColumnInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(DeletePullRequestReviewInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The deleted pull request review. |
deletePullRequestReviewComment
Deletes a pull request review comment.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request review the deleted comment belonged to. |
deleteRef
Delete a Git Ref.
Campos de entrada
input
(DeleteRefInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteTeamDiscussion
Deletes a team discussion.
Aviso de pré-visualização
deleteTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
input
(DeleteTeamDiscussionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
deleteTeamDiscussionComment
Deletes a team discussion comment.
Aviso de pré-visualização
deleteTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
dismissPullRequestReview
Dismisses an approved or rejected pull request review.
Campos de entrada
input
(DismissPullRequestReviewInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Aviso de pré-visualização
importProject
is available under the Import project preview. During the preview period, the API may change without notice.
Campos de entrada
input
(ImportProjectInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new Project!. |
lockLockable
Lock a lockable object.
Campos de entrada
input
(LockLockableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was locked. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Aviso de pré-visualização
markPullRequestReadyForReview
is available under the Draft pull requests preview. During the preview period, the API may change without notice.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that is ready for review. |
mergeBranch
Merge a head into a branch.
Campos de entrada
input
(MergeBranchInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The resulting merge Commit. |
mergePullRequest
Merge a pull request.
Campos de entrada
input
(MergePullRequestInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Aviso de pré-visualização
minimizeComment
is available under the Minimize comments preview. During the preview period, the API may change without notice.
Campos de entrada
input
(MinimizeCommentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The comment that was minimized. |
moveProjectCard
Moves a project card to another place.
Campos de entrada
input
(MoveProjectCardInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The new edge of the moved card. |
|
A unique identifier for the client performing the mutation. |
moveProjectColumn
Moves a project column to another place.
Campos de entrada
input
(MoveProjectColumnInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The new edge of the moved column. |
pinIssue
Pin an issue to a repository.
Aviso de pré-visualização
pinIssue
is available under the Pinned issues preview. During the preview period, the API may change without notice.
Campos de entrada
input
(PinIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was pinned. |
removeAssigneesFromAssignable
Removes assignees from an assignable object.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
The item that was unassigned. |
|
A unique identifier for the client performing the mutation. |
removeLabelsFromLabelable
Removes labels from a Labelable object.
Campos de entrada
input
(RemoveLabelsFromLabelableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(RemoveOutsideCollaboratorInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Campos de entrada
input
(RemoveReactionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The reaction object. |
|
The reactable subject. |
removeStar
Removes a star from a Starrable.
Campos de entrada
input
(RemoveStarInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The starrable. |
reopenIssue
Reopen a issue.
Campos de entrada
input
(ReopenIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was opened. |
reopenPullRequest
Reopen a pull request.
Campos de entrada
input
(ReopenPullRequestInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The pull request that was reopened. |
requestReviews
Set review requests on a pull request.
Campos de entrada
input
(RequestReviewsInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Aviso de pré-visualização
rerequestCheckSuite
is available under the Checks preview. During the preview period, the API may change without notice.
Campos de entrada
input
(RerequestCheckSuiteInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The requested check suite. |
|
A unique identifier for the client performing the mutation. |
resolveReviewThread
Marks a review thread as resolved.
Campos de entrada
input
(ResolveReviewThreadInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The thread to resolve. |
submitPullRequestReview
Submits a pending pull request review.
Campos de entrada
input
(SubmitPullRequestReviewInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The submitted pull request review. |
unlockLockable
Unlock a lockable object.
Campos de entrada
input
(UnlockLockableInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The item that was unlocked. |
unmarkIssueAsDuplicate
Unmark an issue as a duplicate of another issue.
Campos de entrada
input
(UnmarkIssueAsDuplicateInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
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.
Aviso de pré-visualização
unminimizeComment
is available under the Minimize comments preview. During the preview period, the API may change without notice.
Campos de entrada
input
(UnminimizeCommentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The comment that was unminimized. |
unpinIssue
Unpin a pinned issue from a repository.
Aviso de pré-visualização
unpinIssue
is available under the Pinned issues preview. During the preview period, the API may change without notice.
Campos de entrada
input
(UnpinIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue that was unpinned. |
unresolveReviewThread
Marks a review thread as unresolved.
Campos de entrada
input
(UnresolveReviewThreadInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The thread to resolve. |
updateBranchProtectionRule
Create a new branch protection rule.
Campos de entrada
input
(UpdateBranchProtectionRuleInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The newly created BranchProtectionRule. |
|
A unique identifier for the client performing the mutation. |
updateCheckRun
Update a check run.
Aviso de pré-visualização
updateCheckRun
is available under the Checks preview. During the preview period, the API may change without notice.
Campos de entrada
input
(UpdateCheckRunInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
The updated check run. |
|
A unique identifier for the client performing the mutation. |
updateCheckSuitePreferences
Modifies the settings of an existing check suite.
Aviso de pré-visualização
updateCheckSuitePreferences
is available under the Checks preview. During the preview period, the API may change without notice.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated repository. |
updateIssue
Updates an Issue.
Campos de entrada
input
(UpdateIssueInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The issue. |
updateIssueComment
Updates an IssueComment object.
Campos de entrada
input
(UpdateIssueCommentInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
updateLabel
Updates an existing label.
Aviso de pré-visualização
updateLabel
is available under the Labels preview. During the preview period, the API may change without notice.
Campos de entrada
input
(UpdateLabelInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated label. |
updateProject
Updates an existing project.
Campos de entrada
input
(UpdateProjectInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated project. |
updateProjectCard
Updates an existing project card.
Campos de entrada
input
(UpdateProjectCardInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated ProjectCard. |
updateProjectColumn
Updates an existing project column.
Campos de entrada
input
(UpdateProjectColumnInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated project column. |
updatePullRequest
Update a pull request.
Campos de entrada
input
(UpdatePullRequestInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request. |
updatePullRequestReview
Updates the body of a pull request review.
Campos de entrada
input
(UpdatePullRequestReviewInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated pull request review. |
updatePullRequestReviewComment
Updates a pull request review comment.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
updateRef
Update a Git Ref.
Campos de entrada
input
(UpdateRefInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated Ref. |
updateRepository
Update information about a repository.
Campos de entrada
input
(UpdateRepositoryInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated repository. |
updateSubscription
Updates the state for subscribable subjects.
Campos de entrada
input
(UpdateSubscriptionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The input subscribable entity. |
updateTeamDiscussion
Updates a team discussion.
Aviso de pré-visualização
updateTeamDiscussion
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
input
(UpdateTeamDiscussionInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated discussion. |
updateTeamDiscussionComment
Updates a discussion comment.
Aviso de pré-visualização
updateTeamDiscussionComment
is available under the Team discussions preview. During the preview period, the API may change without notice.
Campos de entrada
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
The updated comment. |
updateTopics
Replaces the repository's topics with the given topics.
Campos de entrada
input
(UpdateTopicsInput!
)
Campos de retorno
Nome | Descrição |
---|---|
|
A unique identifier for the client performing the mutation. |
|
Names of the provided topics that are not valid. |
|
The updated repository. |