Activate Workflow - DialNexa Documentation

POST

workflows

{id}

activate

Activate a workflow and start execution for all leads

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

import requests

url = "https://api.dialnexa.com/workflows/{id}/activate"

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-organization-id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.dialnexa.com/workflows/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/workflows/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/workflows/{id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/workflows/{id}/activate")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/workflows/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. Use Update Workflow Status with action: "activate" for new /v1 integrations. This endpoint remains available for existing integrations until then.

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

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

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

Headers

x-organization-id

string

required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

string

required

Response

Workflow activated successfully

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

Activate a workflow and start execution for all leads

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

import requests

url = "https://api.dialnexa.com/workflows/{id}/activate"

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-organization-id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.dialnexa.com/workflows/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/workflows/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/workflows/{id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/workflows/{id}/activate")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/workflows/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

​When to use this

​Pre-flight checklist

​Path parameters

​Errors

​Related endpoints

Authorizations

Headers

Path Parameters

Response

When to use this

Pre-flight checklist

Path parameters

Errors

Related endpoints