Voiceflow bearer token
Function Paths
Define the outcomes a function can return.
See Authentication for credentials and permissions.
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.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the function whose paths to list.
Response
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.
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.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the exit path, referenced by the function code when returning which path to take.
The ID of the function this path belongs to.
The display label shown for this path in the Voiceflow UI; falls back to name when null.
Response
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.
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.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The ID of the function to create the paths for.
Response
Creates every path in the request against the single function it names, and returns the created paths with their generated IDs and labels.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the function path to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns one exit path, including the function it belongs to, the name its code returns to select it, and the label displayed for it.
Changes an existing function path in place. The response carries only a confirmation message, so refetch the function path to read its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the function path to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the exit path, referenced by the function code when returning which path to take.
The display label shown for this path in the Voiceflow UI; falls back to name when null.
Response
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.
A human-readable message confirming the update.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the function path to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
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.
A human-readable message confirming the deletion.