Pause Workflow

Endpoint: PUT /api/workflow/{workflowId}/pause

Pauses an ongoing workflow execution. Any currently running tasks will be completed, but no new tasks will be scheduled until the workflow is resumed.

Path parameters

Parameter	Description	Type	Required/ Optional
workflowId	The execution ID of the workflow to pause.	string	Required.

Response

Returns 200 OK, indicating that the workflow execution has paused successfully.

Returns 400 if an invalid workflow execution ID is provided.

Examples

Pause a workflow execution

Request

curl -X 'PUT' \
  'https://<YOUR-SERVER-URL>/api/workflow/2ce9207f-d4a6-11ef-87b1-b2b27c52ebde/pause' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

Returns 200 OK, indicating that the workflow execution has paused successfully.