Update Workflow

Update editable fields on a workflow such as its name and description. Use the lifecycle endpoints to change run state.

PATCH /workflows/{id}

Update a workflow

cURL

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

200

{
  "id": "wf_abc123",
  "organization_id": "org_xyz",
  "title": "Lead Nurture Sequence",
  "description": "Contacts cold leads three times before marking as unresponsive.",
  "status": "active",
  "created_at": "2024-03-01T09:00:00.000Z",
  "updated_at": "2024-03-02T11:00:00.000Z"
}

Updates one or more editable fields on a workflow. The name and description can be edited at any time and the change applies immediately. The workflow’s status cannot be changed through this endpoint, use the dedicated lifecycle endpoints (Pause, Resume, Cancel, Activate) so the audit trail records the intent cleanly.

When to use this

• Renaming a workflow after the underlying campaign or sequence is renamed in your internal systems.
• Editing the description so dashboard viewers see a more accurate summary of what the workflow does.
• Bulk metadata updates when reorganizing workspaces across teams.

To change the graph (nodes and edges), use the workflow-nodes and workflow-edges endpoints. To change lead enrollment, use Add Lead and Remove Lead.

Path parameters

Parameter	Description
id	The workflow ID, for example wfl_m3v7zb9rk2px.

Body parameters

Field	Description
name	New display name.
description	New description for the workflow.

Errors

• 404 Not Found is returned when the workflow does not exist.
• 400 Bad Request is returned when the body contains no editable fields or when a value fails validation.
• 409 Conflict is returned if you try to change status through this endpoint, use the lifecycle endpoints instead.

Request

curl -X PATCH "https://api.dialnexa.com/v1/workflows/wfl_m3v7zb9rk2px" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "30-Day Lead Nurture v2"}'

Response

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

Related endpoints

• Pause Workflow: change run state.
• Duplicate Workflow: clone before larger edits.
• Get Workflow: confirm the new field values.

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Body

application/json

title · string

description · string

status · enum<string>

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

Response

200

application/json

Success.

id · string

Example:

"wf_abc123"

organization_id · string

Example:

"org_xyz"

title · string

Example:

"Lead Nurture Sequence"

description · string | null

Example:

"Contacts cold leads three times before marking as unresponsive."

status · enum<string>

Workflow lifecycle status. Responses can include running for older workflow records; treat it like active. Use active in new create or update requests.

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

Example:

"active"

created_at · string<date-time>

Example:

"2024-03-01T09:00:00.000Z"

updated_at · string<date-time>

Example:

"2024-03-02T11:00:00.000Z"