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>"
  ]
}
'

import requests

url = "https://app.textql.com/v2/playbooks/{id}"

payload = {
    "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>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>']
  })
};

fetch('https://app.textql.com/v2/playbooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.textql.com/v2/playbooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.textql.com/v2/playbooks/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.textql.com/v2/playbooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.textql.com/v2/playbooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "status": "draft",
  "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>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "Insufficient permissions"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "code": "internal",
    "message": "Internal server error"
  }
}

PATCH

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>"
  ]
}
'

import requests

url = "https://app.textql.com/v2/playbooks/{id}"

payload = {
    "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>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>']
  })
};

fetch('https://app.textql.com/v2/playbooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.textql.com/v2/playbooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.textql.com/v2/playbooks/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.textql.com/v2/playbooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.textql.com/v2/playbooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"cron_string\": \"<string>\",\n  \"connector_ids\": [\n    123\n  ],\n  \"dataset_ids\": [\n    \"<string>\"\n  ],\n  \"email_addresses\": [\n    \"<string>\"\n  ],\n  \"slack_channel_id\": \"<string>\",\n  \"tagged_slack_user_ids\": [\n    \"<string>\"\n  ],\n  \"selected_template_data_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "status": "draft",
  "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>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "permission_denied",
    "message": "Insufficient permissions"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "code": "internal",
    "message": "Internal server error"
  }
}

Authorizations

Authorization

string

header

required

API key or JWT token

Path Parameters

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

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.

Getting Started

API Keys

Members

Roles

Chat

Connectors

Playbooks

Dashboards

Sandcastles

Changes

Update Playbook

Authorizations

Path Parameters

Body

Response