Skip to main content
PUT
/
api
/
v1
/
playbooks
/
{id}
Update a playbook
curl --request PUT \
  --url https://api.kataven.ai/v1/api/v1/playbooks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated copy after the Q2 process change.",
  "display_name": "Refund Workflow (v2)",
  "tags": [
    "refunds",
    "ecommerce",
    "q2"
  ],
  "tool_names": [
    "lookup_order",
    "verify_eligibility",
    "issue_refund_v2"
  ]
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.kataven.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Headers

​
X-Account-ID
string

Tenant database. Required when using a Zitadel JWT.

Path Parameters

​
id
string
required

Playbook id (uuid) or name

Body

application/json

Fields to update

Fields to update

​
description
string
Example:

"Updated copy after the Q2 process change."

​
display_name
string
Example:

"Refund Workflow (v2)"

​
tags
string[]
Example:
["refunds", "ecommerce", "q2"]
​
tool_names
string[]
Example:
[
  "lookup_order",
  "verify_eligibility",
  "issue_refund_v2"
]

Response

OK

​
{key}
string