Update playbook

View as Markdown

Updates a playbook’s mutable fields across any scope. The numbering prefix is immutable. An active playbook is re-validated on schema-affecting edits; project-scope playbooks are frozen once a non-draft run references them.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringOptional1-200 characters
descriptionstringOptional<=5000 characters
iconstringOptional1-64 characters
colorstring or nullOptional
numberingobjectOptional
startableByUsersbooleanOptional
orchestratorobjectOptional
startFormobject or nullOptional
taskslist of objectsOptional
dependencieslist of objectsOptional

Response

The updated playbook.
playbookobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error