Workflows

Update Workflow Status

Changes a workflow status. activate (from draft or paused) runs the pre-activation checks, sets the workflow active and starts every lead that has no execution yet. deactivate and pause (from active) set it paused: no new lead starts, including through an inbound call, and queued calls are not dialed. Leads already inside a step keep advancing: an expiring time hold or a finished call can still move a lead into a Voice Call node, whose call is queued and dialed once the workflow is active again, and an inbound call from such a lead is still routed into the workflow. resume (from paused) sets it active again without starting leads that were uploaded while it was paused; use activate for those.

patch/v1/workflows/{id}/status

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/workflows/{id}/status
  • Auth: HTTP bearer

Path parameters

idstring required
Example:workflow_abc123

Workflow ID

Request body

action'activate' | 'deactivate' | 'pause' | 'resume' 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.

Example request

{
  "action": "activate"
}

Response

Workflow status updated successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "statusCode": 200,
    "message": "Workflow activated successfully",
    "data": {
      "id": "workflow_abc123",
      "title": "Q3 Outreach Workflow",
      "status": "active",
      "description": "Automated follow-up sequence",
      "organization_id": "o14XKPP84rt22g"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.