Pause Workflow

Pause an active workflow. Leads in progress finish their current step, no new steps start, and the workflow can be resumed later.

POST /workflows/{id}/pause

Pause a workflow

cURL

curl --request POST \
  --url https://api.dialnexa.com/v1/workflows/{id}/pause \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "wf_abc123",
  "status": "paused"
}

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

Parameter	Description
id	The workflow ID, for example wfl_m3v7zb9rk2px.

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).

Request

curl -X POST "https://api.dialnexa.com/v1/workflows/wfl_m3v7zb9rk2px/pause" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "wfl_m3v7zb9rk2px",
  "name": "30-Day Lead Nurture",
  "status": "paused",
  "node_count": 5,
  "edge_count": 6,
  "enrolled_leads": 420,
  "created_at": "2024-04-01T08:00:00.000Z"
}

Related endpoints

• Resume Workflow: return a paused workflow to active.
• Cancel Workflow: permanently stop the workflow.
• Get Workflow: confirm the new status.

Authorizations

Authorization · string · header · required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id · string · required

Response

200 - application/json

Success.

id · string

Example:

"wf_abc123"

status · enum<string>

Available options: draft, active, running, paused, completed, cancelled

Example:

"paused"