Skip to main content
PATCH
Update Playbook

Authorizations

Authorization
string
header
required

API key or JWT token

Path Parameters

id
string<uuid>
required

Playbook ID

Body

application/json
name
string

Playbook name

prompt
string

Playbook prompt

cron_string
string

Cron schedule expression

connector_ids
integer<int32>[]

Connector IDs to use

dataset_ids
string[]

Dataset IDs

email_addresses
string[]

Email addresses for report delivery

slack_channel_id
string

Slack channel for report delivery

tagged_slack_user_ids
string[]

Slack user IDs to tag in notifications

selected_template_data_ids
string[]

Template data IDs

Response

Updated playbook

id
string<uuid>
name
string
prompt
string
status
enum<string>
Available options:
draft,
deployed
created_at
string<date-time>
updated_at
string<date-time>
connector_ids
integer<int32>[]

Connector IDs attached to this playbook

cron_string
string

Cron schedule expression. Omitted when not set.

email_addresses
string[]

Email addresses for report delivery. Omitted when empty.

slack_channel_id
string

Slack channel for report delivery. Omitted when not set.