Skip to main content
PATCH
/
v2.0
/
playbooks
/
{playbookId}
Update a Playbook
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "New Playbook",
  "abortOnError": true,
  "timeout": 2000
}'
This response does not have an example.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
playbookId
string
required

The Id of the Playbook

Required string length: 24

Body

application/json
​
name
string

The name of the Playbook

Example:

"New Playbook"

​
abortOnError
boolean

Flag wheter to stop Playbook execution when an assert-error occured

​
timeout
integer

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

Required range: x >= 1
Example:

2000

Response

Successfully updated the Playbook.

⌘I