Skip to main content
POST
Create an edge in a workflow
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.
Creates a directed edge between two nodes in a workflow. Edges encode the “what happens next” decision: after a lead finishes the step at from_node_id, the workflow checks each outgoing edge in order, picks the first edge whose label matches the outcome, and moves the lead to to_node_id. Unlabelled edges always match, they are the default next step for sequential flows. Labelled edges are required for CONDITIONAL nodes and recommended for any node where the outcome can branch.

When to use this

  • Building a new workflow: connect freshly created nodes into a graph after using Create Node.
  • Adding a branch: split a sequential workflow into multiple outcome-based paths.
  • Rewiring a workflow: after deleting an obsolete edge, create the replacement transition.
If you are editing a workflow that is currently active, be aware that edge changes take effect on the next scheduling tick. In-flight leads already past from_node_id are not affected.

Basic transition

For simple linear workflows, create one edge from each node to the next:

Conditional transitions

For CONDITIONAL nodes, create one edge per branch and set the label to match the branch name:
Common label values for call-outcome branches are COMPLETED, FAILED, NO_ANSWER, and BUSY. For boolean conditions, use true and false. Custom values are accepted, but they must match what your CONDITIONAL node emits.

Path parameters

Errors

  • 404 Not Found is returned when either node does not exist or does not belong to this workflow.
  • 409 Conflict is returned when an edge with the same from_node_id, to_node_id, and label already exists.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
from_node_id
string
required

ID of the source node

Example:

"node_abc123"

to_node_id
string
required

ID of the target node

Example:

"node_xyz789"

label
string

Label for the edge (e.g., "FAILED", "COMPLETED", "true", "false")

Maximum string length: 50
Example:

"COMPLETED"

Response

201

Edge created successfully