Skip to main content
PATCH
Update evaluation

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

evaluationID
string
required

The ID of the evaluation to operate on.

Query Parameters

projectID
string
required

The ID of the project to operate on.

Body

application/json
type
enum<string>
required

Identifies an evaluation that produces a true/false result.

Available options:
boolean
truePrompt
string

The criteria describing when the evaluator should return true.

falsePrompt
string

The criteria describing when the evaluator should return false.

name
string
prompt
string

The criteria the evaluator uses to judge a transcript.

enabled
boolean

Whether this evaluation runs automatically against new transcripts.

settings
object | null
description
string | null

A human-readable description of what this evaluation measures.

Response

200 - application/json

Confirms the evaluation's name, criteria, result type, or enabled state were updated. The body is a message only, so refetch the evaluation to read its stored definition.

message
string
required

A human-readable message confirming the update.