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 Forming calls with GraphQL.
abortQueuedMigrations
Clear all of a customer's queued migrations.
Input fields for abortQueuedMigrations
input
(AbortQueuedMigrationsInput!
)
Return fields for abortQueuedMigrations
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
abortRepositoryMigration
Abort a repository migration queued or in progress.
Input fields for abortRepositoryMigration
input
(AbortRepositoryMigrationInput!
)
Return fields for abortRepositoryMigration
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| Did the operation succeed?. |
acceptEnterpriseAdministratorInvitation
Accepts a pending invitation for a user to become an administrator of an enterprise.
Input fields for acceptEnterpriseAdministratorInvitation
Return fields for acceptEnterpriseAdministratorInvitation
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was accepted. |
| A message confirming the result of accepting an administrator invitation. |
acceptEnterpriseMemberInvitation
Accepts a pending invitation for a user to become an unaffiliated member of an enterprise.
Input fields for acceptEnterpriseMemberInvitation
Return fields for acceptEnterpriseMemberInvitation
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The invitation that was accepted. |
| A message confirming the result of accepting an unaffiliated member invitation. |
acceptTopicSuggestion
Applies a suggested topic to the repository.
Input fields for acceptTopicSuggestion
input
(AcceptTopicSuggestionInput!
)
Return fields for acceptTopicSuggestion
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The accepted topic. Warning
Suggested topics are no longer supported Removal on 2024-04-01 UTC. |
accessUserNamespaceRepository
Access user namespace repository for a temporary duration.
Input fields for accessUserNamespaceRepository
Return fields for accessUserNamespaceRepository
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The time that repository access expires at. |
| The repository that is temporarily accessible. |
addAssigneesToAssignable
Adds assignees to an assignable object.
Input fields for addAssigneesToAssignable
input
(AddAssigneesToAssignableInput!
)
Return fields for addAssigneesToAssignable
Name | Description |
---|---|
| The item that was assigned. |
| A unique identifier for the client performing the mutation. |
addBlockedBy
Adds a 'blocked by' relationship to an issue.
Input fields for addBlockedBy
input
(AddBlockedByInput!
)
Return fields for addBlockedBy
Name | Description |
---|---|
| The issue that is blocking the given issue. |
| A unique identifier for the client performing the mutation. |
| The issue that is blocked. |
addComment
Adds a comment to an Issue or Pull Request.
Input fields for addComment
input
(AddCommentInput!
)
Return fields for addComment
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 for addDiscussionComment
input
(AddDiscussionCommentInput!
)
Return fields for addDiscussionComment
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The newly created discussion comment. |
addDiscussionPollVote
Vote for an option in a discussion poll.
Input fields for addDiscussionPollVote
input
(AddDiscussionPollVoteInput!
)
Return fields for addDiscussionPollVote
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The poll option that a vote was added to. |
addEnterpriseOrganizationMember
Adds enterprise members to an organization within the enterprise.
addEnterpriseSupportEntitlement
Adds a support entitlement to an enterprise member.
addLabelsToLabelable
Adds labels to a labelable object.
Input fields for addLabelsToLabelable
input
(AddLabelsToLabelableInput!
)
Return fields for addLabelsToLabelable
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.
Warning
addProjectCard
is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields for addProjectCard
input
(AddProjectCardInput!
)
Return fields for addProjectCard
Name | Description |
---|---|
| The edge from the ProjectColumn's card connection. |
| A unique identifier for the client performing the mutation. |
| The ProjectColumn. |
addProjectColumn
Adds a column to a Project.
Warning
addProjectColumn
is deprecated.
Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.
Input fields for addProjectColumn
input
(AddProjectColumnInput!
)
Return fields for addProjectColumn
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The edge from the project's column connection. |
| The project. |
addProjectV2DraftIssue
Creates a new draft issue and add it to a Project.
Input fields for addProjectV2DraftIssue
input
(AddProjectV2DraftIssueInput!
)
Return fields for addProjectV2DraftIssue
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The draft issue added to the project. |
addProjectV2ItemById
Links an existing content instance to a Project.
Input fields for addProjectV2ItemById
input
(AddProjectV2ItemByIdInput!
)
Return fields for addProjectV2ItemById
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The item added to the project. |
addPullRequestReview
Adds a review to a Pull Request.
Input fields for addPullRequestReview
input
(AddPullRequestReviewInput!
)
Return fields for addPullRequestReview
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 for addPullRequestReviewComment
Return fields for addPullRequestReviewComment
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 for addPullRequestReviewThread
input
(