Skip to main content
PATCH
/
v2
/
playbooks
/
{id}
Update Playbook
curl --request PATCH \
  --url https://app.textql.com/v2/playbooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prompt": "<string>",
  "cron_string": "<string>",
  "connector_ids": [
    123
  ],
  "dataset_ids": [
    "<string>"
  ],
  "email_addresses": [
    "<string>"
  ],
  "slack_channel_id": "<string>",
  "tagged_slack_user_ids": [
    "<string>"
  ],
  "selected_template_data_ids": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connector_ids": [
    123
  ],
  "cron_string": "<string>",
  "email_addresses": [
    "<string>"
  ],
  "slack_channel_id": "<string>"
}

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.