Update workflow

updateWorkflow(projectReference: String!, workflowId: String!, input: UpdateWorkflowInput!): WorkflowSource!

Requires project.runs.write.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
workflowIdString!Yes
inputUpdateWorkflowInput!Yes

Input fields

input

UpdateWorkflowInput

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

Response

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

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

All fields of WorkflowSource.

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

Example

graphql
mutation UpdateWorkflow($projectReference: String!, $workflowId: String!, $input: UpdateWorkflowInput!) {
  updateWorkflow(projectReference: $projectReference, workflowId: $workflowId, input: $input) {
    id
    name
    description
    editMode
    schedulable
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "workflowId": "00000000-0000-4000-8000-000000000001",
  "input": {}
}