Skip to navigation

Update a playbook definition

View as Markdown

Partially updates the playbook definition identified by playbookId and bumps its version. Authorization: organization administrators only — other callers are rejected with 403. All body fields are optional: name (1-200), description (<=5000), spaceTypes (replaces the list), tasks (<=30, replaces the whole list; each { id, title, instructions?, dependsOn? (ids of tasks that must complete first) }), actions (<=20, replaces the whole list; each { installedActionId, preApproval?, postApproval?, dependsOn? (task ids only) }). Response: { data: Playbook }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

playbookIdstringRequired

Request

tasks and actions replace the whole list. Every update bumps version.

namestringOptional1-200 characters
descriptionstringOptional<=5000 characters
spaceTypeslist of stringsOptional
taskslist of objectsOptional
modelstring or nullOptional<=200 characters
actionslist of objectsOptional

Response

The updated playbook definition.
dataobject