Pause Workflow

This API pauses the execution of a running workflow. Any currently running tasks will finish, but no new tasks will be scheduled until the workflow is resumed.

note

This method is intended for pausing your workflow for debugging purposes. For handling your use cases in a live environment, refer to our documentation pausing workflows for external signals.

Input Payload

Attribute	Description
workflowId	The unique identifier of the workflow to be paused.

API Endpoint

PUT /workflow/{workflowId}/pause

Client SDK Methods

Java

BulkResponse pauseWorkflow(List<String> workflowIds) throws ApiException

Go

func (e *WorkflowExecutor) Pause(workflowId string) error

Python

WorkflowResourceApi.pause_workflow1(self, workflow_id, **kwargs)

C#

void WorkflowResourceApi.PauseWorkflow(string workflowId)

JavaScript

WorkflowExecutor.pauseWorkflow(
    workflowId: string,
): CancelablePromise<any>

Typescript

WorkflowExecutor.pauseWorkflow(
    workflowId: string,
): CancelablePromise<any>

Clojure

(workflow-resource/pause-workflow [options workflow-id])