Delete state

curl --request DELETE \
  --url https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "message": "<string>"
}

Delete state

Discards the stored state for one conversation, so the next turn on that `userID` begins from the start. The response carries only a confirmation message.

DELETE

/v1/stable/conversation-state/{userID}

Delete state

curl --request DELETE \
  --url https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/conversation-state/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

userID

string

required

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

Available options: draft, published

Response

200 - application/json

Confirms the user's stored state was deleted. The body is a message only, so nothing of the discarded stack, storage, or variables comes back with it.

message

string

required

A human-readable message confirming the deletion.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Delete state

Authorizations

Path Parameters

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks