Skip to main content
PATCH
Update playbook

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

playbookID
string
required

The ID of the playbook to operate on.

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

Body

application/json
name
string
settings
object
description
string | null

A human-readable description of what the playbook does.

instructions
string · object · object · object · object · object[] | null
endTool
object | null
cardTool
object | null
buttonTool
object | null
skipTurnTool
object | null
webSearchTool
object | null
callForwardTool
object | null
knowledgeBaseTool
object | null

Response

200 - application/json

Confirms the playbook was updated. The response is a message, not the revised playbook, so fetch it again to read back the instructions or settings that changed.

message
string
required

A human-readable message confirming the update.