Skip to main content
POST
Pause a running workflow
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. Use Update Workflow Status with action: "pause" for new /v1 integrations. This endpoint remains available for existing integrations until then.
Pauses an active workflow. Any lead currently in an active step, for example a live voice call or an in-flight webhook delivery, is allowed to complete that step. After that, no new steps are triggered for any lead until the workflow is resumed. Leads that have not started yet remain queued. Use Resume Workflow to return the workflow to active state. Time-delay countdowns continue from where they left off, so the pause does not “lengthen” the delay for waiting leads.

When to use this

Pause is the right call when you want a reversible stop, not a permanent shutdown. Common cases:
  • Carrier or telephony incidents: pause outbound activity until upstream connectivity recovers, then resume.
  • Holiday or quiet-hours windows: stop dialling temporarily to honor a known no-call window.
  • Investigation: pause while you investigate a complaint, prompt change, or data-quality issue, then resume after remediation.
  • Configuration changes: pause before adjusting concurrency or retry settings, then resume under the new configuration.
If you need to stop the workflow permanently, use Cancel Workflow instead. Cancellation cannot be reversed.

Behavior

  • In-flight steps are not interrupted.
  • New steps stop firing as soon as the pause takes effect.
  • Time-delay nodes do not reset their countdowns.
  • The workflow’s status becomes paused and remains paused until Resume Workflow is called.

Path parameters

Errors

  • 404 Not Found is returned when the workflow does not exist.
  • 409 Conflict is returned when the workflow is not currently active (for example it is already paused or cancelled).

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

Workflow paused successfully