Update task

updateTask(projectReference: String!, taskId: String!, input: UpdateTaskInput!): TaskSource!

Requires project.runs.write.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
taskIdString!Yes
inputUpdateTaskInput!Yes

Input fields

input

UpdateTaskInput

FieldTypeRequiredDescription
nameString!Yes
descriptionStringNoOmit it to keep the description; null clears it.
schedulableBooleanNoOmit it to keep the value.
sourceTargetKindWriteTargetKindNoThe source to write; default project.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

Returns TaskSource!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
nameString!
descriptionString
targetString!
sourcePathString!
sourceString!The source text of the task file.
schedulableBoolean!
editModeTaskEditMode!

All fields of TaskSource.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation UpdateTask($projectReference: String!, $taskId: String!, $input: UpdateTaskInput!) {
  updateTask(projectReference: $projectReference, taskId: $taskId, input: $input) {
    id
    name
    description
    editMode
    schedulable
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "taskId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "name": "example"
  }
}