Delete workflow

deleteWorkflow(projectReference: String!, workflowId: String!, input: WriteTargetInput): SourceDeletionResult!

Requires project.runs.write.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
workflowIdString!Yes
inputWriteTargetInputNo

Input fields

input

WriteTargetInput

FieldTypeRequiredDescription
sourceTargetKindWriteTargetKindNoThe source to write; default project.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

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

FieldTypeDescription
okBoolean!Always true: the deletion completed. A failed deletion is a GraphQL error.

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

Example

graphql
mutation DeleteWorkflow($projectReference: String!, $workflowId: String!, $input: WriteTargetInput) {
  deleteWorkflow(projectReference: $projectReference, workflowId: $workflowId, input: $input) {
    ok
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "workflowId": "00000000-0000-4000-8000-000000000001"
}