Update playbook
PATCH
Update playbook

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

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

Body

name
string
settings
object
description
string

A human-readable description of what the playbook does.

instructions
string

Markdown text. Backticked Name resolves to a tool, playbook, or workflow reference; braced {name} resolves to a variable or entity reference. Tokens that do not resolve are stored as literal text and reported back in the response.

endTool
object
cardTool
object
buttonTool
object
skipTurnTool
object
webSearchTool
object
callForwardTool
object
knowledgeBaseTool
object

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.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.