v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Playbooks

Update a Playbook

Updates Playbook data in a Project.

patch/v2.0/playbooks/{playbookId}

Path parameters

playbookIdstring required

The unique identifier for the Playbook.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

namestring

The name of the Playbook

abortOnErrorboolean

Flag whether to stop Playbook execution when an assert-error occurred

timeoutinteger

A time (in ms) after which a playbook step is 'invalid/failed'

Example request

{
  "name": "New Playbook",
  "timeout": 2000
}

Response

Playbook successfully updated.