Skip to main content
PATCH
Changes state - verify before retry Update Workflow Status changes whether a workflow is running or paused. Use this endpoint instead of the older action-specific workflow endpoints when integrating with /v1.

​
When To Use Update Workflow Status

  • Use activate when a validated workflow should start execution for its leads. It is also the action to use after uploading leads to a paused workflow.
  • Use deactivate or pause when an active workflow should stop starting new leads. The two are the same operation.
  • Use resume when a paused workflow should be active again and every lead it should process already has an execution.

​
Status Actions

Each action moves the workflow to a specific status:

​
What pausing does not stop

Pausing changes the workflow status only. A lead that is already inside the workflow is not frozen:
  • When a lead’s wait step expires, the lead moves on to the next node, even in a paused workflow.
  • When a call placed by a Voice Call node finishes, the lead is routed along that call’s outcome.
  • If either moves the lead into a Voice Call node, a call is queued. It is not dialed while the workflow is paused, and it is dialed once the workflow is active again after resume or activate.
  • Application and Custom Function nodes the lead reaches still run.
  • An inbound call from a lead that is already inside the workflow is still routed to the matching Voice Call node. A lead without an active execution (not started yet, or already finished) is not routed while the workflow is paused.
Pausing therefore holds outbound calls but does not cancel them: they go out when the workflow is active again. Removing a lead with Delete Workflow Lead does not cancel its scheduled steps either. See Workflow Statuses for the full status model, activation validation rules, and how lead-level statuses differ from the workflow container status.

​
Verify The Result

The response includes the full workflow record in data.data, and data.message names the action, for example Workflow activated successfully. Confirm that data.data.status matches the requested transition, then call Get Workflow Details if your integration needs to refresh the workflow record later.

​
Common Errors

  • 400 Bad Request means the action is invalid or the workflow status does not allow the transition.
  • 422 Unprocessable Entity means activate ran the pre-activation checks and the workflow failed them; the body lists what to fix.
  • 401 Unauthorized means the API key is missing or invalid.
  • 404 Not Found means the workflow ID was not found in this workspace. A workflow that belongs to another workspace is reported the same way.
See API errors for the standard error format.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workflow ID

Example:

"workflow_abc123"

Body

application/json
​
action
enum<string>
required

activate validates the workflow, sets it active and starts leads without an execution; deactivate and pause set it paused, which stops new lead starts and holds queued calls until it is active again, but does not stop leads already in a step from advancing; resume sets a paused workflow active without starting leads added while paused.

Available options:
activate,
deactivate,
pause,
resume
Example:

"activate"

Response

Workflow status updated successfully.

​
success
enum<boolean>
required
Available options:
true
​
error
enum<boolean>
required
Available options:
false
​
statusCode
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required
​
timestamp
string<date-time>
required