Voiceflow bearer token
Function Variables
Define the inputs and outputs of a function.
See Authentication for credentials and permissions.
Returns every function variable in its function. A function variable is an input or output a function declares. 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 variables to list.
Response
Returns every variable declared on a single function, selected by the functionID query parameter, each marked as an input or an output and named as the function code references it.
Adds a function variable to its function, an input or output a function declares. 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 used to reference the variable in the function code.
The ID of the function this variable belongs to.
A human-readable description of what the variable holds.
Response
Creates the function variable and returns it, including its new ID, whether it is an input or an output, and the functionID of the function that declares it.
Adds several function variables to its function in one request, each taking the fields the single-create call takes. The response carries the created function variables 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 variables for.
Response
Returns the newly created function variables, each with its own ID, its input or output kind, and the functionID of the function it was attached to.
Returns a single function variable by ID, with the fields that define it. A function variable is an input or output a function declares.
Authentication
Voiceflow bearer token
Path parameters
The ID of the variable 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 a single function variable, with the name the function code uses to reference it, whether it is an input or an output, and the ID of the function that declares it.
Changes an existing function variable in place. The response carries only a confirmation message, so refetch the function variable to read its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the variable 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 used to reference the variable in the function code.
A human-readable description of what the variable holds.
Response
Confirms the function variable was updated. The body confirms the write rather than returning the variable, so fetch the variable again to check its name, description, and whether it is an input or an output.
A human-readable message confirming the update.
Deletes a single function variable by ID. A function variable is an input or output a function declares. The response carries only a confirmation message, so refetch the function variables to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the variable 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 function variable was deleted. A message is all that comes back, so refetch the function's variables to see which inputs and outputs its code can still reference.
A human-readable message confirming the deletion.