Skip to main content

Update a playbook

PATCH 

/api/v1/playbooks/:playbook_id

Updates any of name, description, definition and policy_ids. Only a change to definition or policy_ids archives a new version; a rename or a rewrite the playbook already holds leaves version where it is. A case keeps the version it was created on.

Every write is checked as on create against the playbook as it stands after it: 400 VALIDATION_FAILED for one left without policy_ids, 403 POLICY_GRANT_NOT_HELD for a policy whose grants the caller does not hold, 403 ACTION_NOT_HELD for an executor it may not start, an EXECUTOR_NOT_FOUND problem for one that does not exist, EXECUTOR_ACTION_REQUIRED or EXECUTOR_ACTION_UNAVAILABLE for an mcp tool action a run could not call, EXECUTOR_TOOL_UNSUPPORTED for a client tool executor, TRANSFORMATION_TOOL_UNSUPPORTED for a client or mcp transformation tool.

Request​

Responses​

Playbook updated