Sign in

v1

latestOpenAPI 3.1.02026-07-263971,2281.1 MB
PlaybookService

UpdatePlaybook

post/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

playbookIdstring
namestring nullable
promptstring nullable
status'STATUS_UNKNOWN' | 'STATUS_ACTIVE' | 'STATUS_INACTIVE' | 'STATUS_EMPTY' | 'ALL_PLAYBOOKS'
triggerType'TRIGGER_TYPE_UNKNOWN' | 'TRIGGER_TYPE_CRON' | 'TRIGGER_TYPE_WEBHOOK'
cronStringstring nullable
connectorIdinteger nullable

Deprecated: use connector_ids instead

referenceReportIdstring nullable
paradigmType'TYPE_UNKNOWN' | 'TYPE_UNIVERSAL'
slackChannelIdstring nullable
reportOutputStyle'REPORT_STYLE_UNKNOWN' | 'EXECUTIVE_REPORT' | 'VERBOSE' | 'CONCISE'
templateHeaderIdstring nullable
maxConcurrentTemplatesinteger nullable
autoOptimizeConcurrencyboolean nullable
llmModel'MODEL_UNKNOWN' | 'MODEL_DEFAULT_SMALL' | 'MODEL_DEFAULT' | 'MODEL_DEFAULT_LARGE' | 'MODEL_DEFAULT_REASONING' | 'MODEL_HAIKU_4_5' | 'MODEL_OPUS_4_8' | 'MODEL_FABLE_5' | 'MODEL_SONNET_5' | 'MODEL_GPT_5_6_SOL' | 'MODEL_GEMINI_3_FLASH' | 'MODEL_GEMINI_3_PRO' | 'MODEL_GEMINI_3_1_PRO' | 'MODEL_GEMINI_3_5_FLASH' | 'MODEL_GPT_5_6_TERRA' | 'MODEL_GPT_5_6_LUNA' | 'MODEL_DEEPSEEK_3_2' | 'MODEL_GLM_5' | 'MODEL_VLLM' | 'MODEL_KIMI_K2_6' | 'MODEL_GLM_5_2' | 'MODEL_KIMI_K2_7_CODE' | 'MODEL_QWEN3_7_PLUS' | 'MODEL_MUSE_SPARK_1_1'
chatAccessMode'CHAT_ACCESS_MODE_INHERIT' | 'CHAT_ACCESS_MODE_CUSTOM'
chatIsPublicboolean nullable
recipientEmailColumnstring nullable
teamsChannelIdstring nullable

Response

Success

Example response

{
  "playbook": {
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "duplicatedAt": "2023-01-15T01:30:15.01Z"
  }
}