Activate Workflow

Move a workflow from draft to active so enrolled leads start moving through the configured sequence.

POST /workflows/{id}/activate

Activate a workflow

cURL

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

200

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

Activates a workflow that is currently in draft status. Once active, the workflow begins processing every enrolled lead through the configured sequence on the next scheduling tick. Calls and other node actions start firing immediately, so the workflow must be fully configured, nodes, edges, agent assignments, dynamic variables, before you call this endpoint. The status returned in the response transitions from draft to active.

When to use this

• Going live: you have finished building the workflow in the dashboard or via API and are ready to start dialling enrolled leads.
• Reactivation after edits: you took a workflow back to draft to apply structural changes and you want to put it back into production.

If the workflow is currently paused, use Resume Workflow instead, that endpoint is the correct verb for paused → active. Use this endpoint only for draft → active.

Pre-flight checklist

Before activating, confirm:

• Every non-terminal node has at least one outgoing edge (List Edges).
• Every VOICE_CALL node has an assigned agent and outbound phone number.
• The prompt for each agent references only variable keys returned by Get Variable Keys.
• Concurrency settings match your Concurrency and limits policy.

Activation is the moment outbound calls start firing, so the cost of a mis-configured workflow at this point is real.

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 in draft status (use Resume Workflow for paused workflows).
• 400 Bad Request is returned when the workflow’s graph fails pre-activation validation (for example a node missing required configuration).

Request

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

Response

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

Related endpoints

• Resume Workflow: resume a paused workflow.
• Pause Workflow: pause an active workflow.
• Cancel Workflow: permanently stop a 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:

"active"