Update Workflow Status

PATCH

workflows

{id}

status

curl --request PATCH \
  --url https://api.dialnexa.com/v1/workflows/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "activate"
}
'

{
  "statusCode": 200,
  "message": "Workflow activated successfully",
  "data": {
    "id": "workflow_abc123",
    "title": "Q3 Outreach Workflow",
    "status": "active",
    "description": "Automated follow-up sequence",
    "createdAt": "2026-07-03T10:30:00.000Z",
    "updatedAt": "2026-07-03T10:45:00.000Z"
  }
}

{
  "statusCode": 400,
  "message": "Invalid action. Must be one of: activate, deactivate, pause, resume",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Workflow not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Changes state - verify before retry

Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.

Update Workflow Status changes whether a workflow is running, paused, or inactive. Use this endpoint instead of the older action-specific workflow endpoints when integrating with /v1.

When To Use Update Workflow Status

Use activate when a validated workflow should start execution for its leads.
Use deactivate when an active workflow should stop accepting new execution work.
Use pause when a running workflow needs a temporary stop.
Use resume when a paused workflow should continue.

Status Actions

Each action moves the workflow to a specific status:

Action	Status before	Status after	Result
`activate`	`draft` or `paused`	`active`	Validates the workflow, then starts execution for leads that do not already have execution records.
`deactivate`	`active`	`paused`	Stops future lead movement. Leads already inside an active call step can finish.
`pause`	`active`	`paused`	Pauses a running workflow.
`resume`	`paused`	`active`	Continues lead processing from each lead’s current node.

See Workflow Statuses for the full status model, activation validation rules, and how lead-level statuses differ from the workflow container status.

Verify The Result

The response includes data.status. Confirm that the status matches the requested transition, then call Get Workflow Details if your integration needs to refresh the full workflow record.

Common Errors

400 Bad Request means the action is invalid, the workflow status does not allow the transition, or workflow validation failed.
403 Forbidden means the workflow does not belong to the authenticated workspace.
404 Not Found means the workflow ID was not found.

See Errors for the standard error format.

List Workflows: find workflows in your workspace.
Get Workflow Details: fetch a workflow by ID.
Workflow Leads: inspect leads attached to a workflow.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Workflow ID

Example:

"workflow_abc123"

Body

application/json

action

enum<string>

required

The workflow status transition to apply.

Available options:

activate,

deactivate,

pause,

resume

Example:

"activate"

Response

Workflow status updated successfully.

statusCode

number

Example:

200

message

string

Example:

"Workflow activated successfully"

data

object

Show child attributes

List Workflow LeadsList leads enrolled in a workflow.

curl --request PATCH \
  --url https://api.dialnexa.com/v1/workflows/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "activate"
}
'

{
  "statusCode": 200,
  "message": "Workflow activated successfully",
  "data": {
    "id": "workflow_abc123",
    "title": "Q3 Outreach Workflow",
    "status": "active",
    "description": "Automated follow-up sequence",
    "createdAt": "2026-07-03T10:30:00.000Z",
    "updatedAt": "2026-07-03T10:45:00.000Z"
  }
}

{
  "statusCode": 400,
  "message": "Invalid action. Must be one of: activate, deactivate, pause, resume",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Workflow not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

When To Use Update Workflow Status

Status Actions

Verify The Result

Common Errors

Authorizations

Path Parameters

Body

Response

​When To Use Update Workflow Status

​Status Actions

​Verify The Result

​Common Errors

​Related Endpoints

Authorizations

Path Parameters

Body

Response

When To Use Update Workflow Status

Status Actions

Verify The Result

Common Errors

Related Endpoints