Skip to main content
POST
/
v1
/
playbooks
/
update
UpdatePlaybook
curl --request POST \
  --url https://app.textql.com/v1/playbooks/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playbookId": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "status": "STATUS_UNKNOWN",
  "triggerType": "TRIGGER_TYPE_UNKNOWN",
  "cronString": "<string>",
  "datasetIds": [
    "<string>"
  ],
  "connectorIds": [
    123
  ],
  "referenceReportId": "<string>",
  "paradigmOptions": {
    "basic": {}
  },
  "paradigmType": "TYPE_UNKNOWN",
  "emailAddresses": [
    "<string>"
  ],
  "slackChannelId": "<string>",
  "taggedSlackUserIds": [
    "<string>"
  ],
  "reportOutputStyle": "REPORT_STYLE_UNKNOWN"
}
'
{
  "playbook": {
    "id": "<string>",
    "orgId": "<string>",
    "memberId": "<string>",
    "connectorId": 123,
    "name": "<string>",
    "prompt": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "status": "STATUS_UNKNOWN",
    "triggerType": "TRIGGER_TYPE_UNKNOWN",
    "cronString": "<string>",
    "datasetIds": [
      "<string>"
    ],
    "referenceReportId": "<string>",
    "latestChatId": "<string>",
    "emailAddresses": [
      "<string>"
    ],
    "slackChannelId": "<string>",
    "taggedSlackUserIds": [
      "<string>"
    ],
    "llmModel": "MODEL_UNKNOWN",
    "paradigmOptions": {
      "basic": {}
    },
    "paradigmType": "TYPE_UNKNOWN",
    "isRunning": true,
    "owner": {
      "memberId": "<string>",
      "memberEmail": "<string>",
      "memberName": "<string>",
      "memberPictureUrl": "<string>"
    },
    "hasWritePermission": true,
    "isSubscribed": true,
    "reportOutputStyle": "REPORT_STYLE_UNKNOWN",
    "templateHeaderId": "<string>",
    "selectedTemplateDataIds": [
      "<string>"
    ],
    "maxConcurrentTemplates": 123,
    "autoOptimizeConcurrency": true,
    "connectorIds": [
      123
    ]
  },
  "updatedFields": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
playbookId
string
Minimum string length: 1
name
string | null
prompt
string | null
status
enum<string> | null
Available options:
STATUS_UNKNOWN,
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_EMPTY
triggerType
enum<string> | null
Available options:
TRIGGER_TYPE_UNKNOWN,
TRIGGER_TYPE_CRON,
TRIGGER_TYPE_WEBHOOK
cronString
string | null
datasetIds
string[]
connectorIds
integer<int32>[]
referenceReportId
string | null
paradigmOptions
paradigm_options · object
  • paradigm_options
  • paradigm_options
  • paradigm_options
  • paradigm_options
  • paradigm_options
  • paradigm_options
  • paradigm_options
paradigmType
enum<string> | null
Available options:
TYPE_UNKNOWN,
TYPE_SQL,
TYPE_RESEARCH,
TYPE_ONTOLOGY,
TYPE_BASIC,
TYPE_TABLEAU,
TYPE_EXPERIMENTAL,
TYPE_UNIVERSAL
emailAddresses
string[]
slackChannelId
string | null
taggedSlackUserIds
string[]
reportOutputStyle
enum<string> | null
Available options:
REPORT_STYLE_UNKNOWN,
EXECUTIVE_REPORT,
VERBOSE,
CONCISE

Response

Success

playbook
playbook · object
updatedFields
string[]
updatedAt
string<date-time>

RFC 3339 timestamp format (e.g., "2024-12-25T12:00:00Z")