Endpoint
GET
/v1/stable/function-path

Returns every function path in its function. A function path is one of the named exits a function can return through. The call takes no paging parameters, so one request yields the whole set.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

functionID
string
required

The ID of the function whose paths to list.

Response

200 - application/json

Returns every exit path declared on the function, each with the name the function code returns to select it and the display label shown in Voiceflow.

paths
object[]
required
StableFunctionPath — see its attributes above
Endpoint
POST
/v1/stable/function-path

Adds a function path to its function, one of the named exits a function can return through. The response carries the ID that later calls address it by.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string
required

The name of the exit path, referenced by the function code when returning which path to take.

functionID
string
required

The ID of the function this path belongs to.

label
string

The display label shown for this path in the Voiceflow UI; falls back to name when null.

Response

201 - application/json

Creates the exit path and returns it with its generated ID and the function it belongs to. The name is the value the function code returns to send the workflow down this branch.

path
object
required
StableFunctionPath — see its attributes above
Endpoint
POST
/v1/stable/function-path/batch

Adds several function paths to its function in one request, each taking the fields the single-create call takes. The response carries the created function paths in the same shape the list call returns.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

functionID
string
required

The ID of the function to create the paths for.

paths
object[]
required

Response

201 - application/json

Creates every path in the request against the single function it names, and returns the created paths with their generated IDs and labels.

paths
object[]
required
StableFunctionPath — see its attributes above
Endpoint
GET
/v1/stable/function-path/{pathID}

Returns a single function path by ID, with the fields that define it. A function path is one of the named exits a function can return through.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

pathID
string
required

The ID of the function path to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns one exit path, including the function it belongs to, the name its code returns to select it, and the label displayed for it.

path
object
required
StableFunctionPath — see its attributes above
Endpoint
PATCH
/v1/stable/function-path/{pathID}

Changes an existing function path in place. The response carries only a confirmation message, so refetch the function path to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

pathID
string
required

The ID of the function path to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string

The name of the exit path, referenced by the function code when returning which path to take.

label
string

The display label shown for this path in the Voiceflow UI; falls back to name when null.

Response

200 - application/json

Confirms the path's name or label was changed. The body is a message only, and because the name is what function code returns to select this path, renaming it affects that code.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/function-path/{pathID}

Deletes a single function path by ID. A function path is one of the named exits a function can return through. The response carries only a confirmation message, so refetch the function paths to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

pathID
string
required

The ID of the function path to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Confirms the exit path was removed from its function. The body is a message only, so refetch the function's paths to see the branches it can still take.

message
string
required

A human-readable message confirming the deletion.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.