Skip to main content
PATCH
Update state

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

userID
string
required

The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.

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).

version
enum<string>
required

Which version of the environment to read: the editable draft or the published one.

Available options:
draft,
published

Body

application/json
stack
object[]
required

The execution stack for the conversation, from root to innermost frame.

storage
object
required

Internal runtime storage persisted across turns of the session.

variables
object
required

The current values of the agent variables for this session.

Response

200 - application/json

Confirms the conversation state was written for that user. The body carries a message only, so fetch the state again to see the stack, storage, and variables as they now stand.

message
string
required

A human-readable message confirming the update.