The annotation for the workflow. It is used to pre-populate data from FK relations of the event data which can be used in filters and execution of the workflow.
Filters to applied on an event attribute to determine when the workflow should trigger. Supports:
Comparison Operators: - ~eq: Exact match (any type) - ~gte: Greater than or equal (numbers) - ~lte: Less than or equal (numbers) - ~in: Check if value is in array
String Operators: - ~starts: String starts with - ~ends: String ends with - ~contains: String contains - ~regex: Regular expression match
Logical Operators: - ~and: All conditions must match - ~or: Any condition must match
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Thena AI","colors":{"primary":"#6A00FF","light":"#6A00FF","dark":"#6A00FF"},"logo":{"light":"https://mintcdn.com/thena-840ce5ec/fnPhXvYfm-TNmZho/images/docs/Thena-logo.svg?fit=max\u0026auto=format\u0026n=fnPhXvYfm-TNmZho\u0026q=85\u0026s=0536e8ca25c4edb9de80cf3e5bc66b66","dark":"https://mintcdn.com/thena-840ce5ec/fnPhXvYfm-TNmZho/logo/Group%2038%20(2).svg?fit=max\u0026auto=format\u0026n=fnPhXvYfm-TNmZho\u0026q=85\u0026s=dc407af2e287b4714cedea5b8d7abf4d"},"favicon":"/logo/favicon.svg","api":{"openapi":[],"playground":{"display":"interactive","proxy":false}},"navbar":{"links":[{"label":"Website","href":"https://www.thena.ai/"},{"label":"Status","href":"https://status-platform.thena.ai/"}],"primary":{"type":"button","label":"Get started","href":"https://thena.ai/signup"}},"footer":{"socials":{"x":"https://x.com/thenaplatform","github":"https://github.com/thena-ai","linkedin":"https://www.linkedin.com/company/thena-platform","youtube":"https://www.youtube.com/@thenaplatform","reddit":"https://www.reddit.com/r/ThenaAI/","instagram":"https://www.instagram.com/thenaplatform/"}},"contextual":{"options":["copy","view","chatgpt","claude"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"thena-840ce5ec","hasAudioNarration":false,"actualSubdomain":"thena-840ce5ec","customDomains":["docs.thena.ai"],"gitSource":{"type":"github","owner":"thena-ai","repo":"thena-platform","deployBranch":"production","contentDirectory":"apps/platform-docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":true},"entitlements":{},"buildId":"6ae9240babb6d0c12b81b578:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API reference","count":308},{"language":"default","tag":"Platform","count":168},{"language":"default","tag":"Guides","count":126},{"language":"default","tag":"MCP tools","count":61},{"language":"default","tag":"Accounts","count":55},{"language":"default","tag":"Agent studio","count":53},{"language":"default","tag":"Tickets","count":45},{"language":"default","tag":"Workflows","count":37},{"language":"default","tag":"Teams","count":27},{"language":"default","tag":"Ticketing","count":23}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"_includes/style.css","content":"html.dark{--primary: #6A00FF !important;--primary-foreground: white !important;--nextra-primary-hue: 265 !important;--nextra-primary-saturation: 100% !important}html.dark .nx-text-primary-600,html.dark .nx-border-primary-600,html.dark .nx-bg-primary-600,html.dark [class*=\"primary-600\"]{color:#6A00FF!important;border-color:#6A00FF!important;background-color:#6A00FF!important}html.dark .hover\\:nx-text-primary-600:hover,html.dark .hover\\:nx-border-primary-600:hover,html.dark .hover\\:nx-bg-primary-600:hover{color:#6A00FF!important;border-color:#6A00FF!important;background-color:#6A00FF!important}img,.nx-img,.nextra-content img,.dark .nextra-content img,[class*=\"image\"],[class*=\"img\"]{border-radius:4px!important}.card,.nx-card,[class*=\"card\"],div[class*=\"Card\"],.nextra-card,.nx-rounded-xl,.nx-rounded-lg{border-radius:4px!important}.banner,.nx-banner,[class*=\"banner\"],.alert,.nx-alert,[class*=\"alert\"],.callout,.nx-callout,[class*=\"callout\"]{border-radius:4px!important}.group,[role=\"button\"],[role=\"region\"],[data-state=\"open\"],[data-state=\"closed\"],[class*=\"rounded\"]{border-radius:4px!important}pre,code,.nx-pre,.nx-code,[class*=\"code-block\"],.nextra-code-block{border-radius:4px!important}button,.button,.nx-button,[class*=\"btn\"],[type=\"button\"],[type=\"submit\"]{border-radius:4px!important}input,textarea,select,.nx-input,.nx-textarea,.nx-select{border-radius:4px!important}"}],"page":{"pagePath":"api-reference/workflows/workflows/update-a-workflow","slug":"/api-reference/workflows/workflows/update-a-workflow","pageMetadata":{"openapi":"patch /api/v1/workflows/{workflowUniqueIdentifier}","title":"Update a workflow","description":null,"href":"/api-reference/workflows/workflows/update-a-workflow"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /api/v1/workflows/{workflowUniqueIdentifier}","title":"Update a workflow","description":null,"href":"/api-reference/workflows/workflows/update-a-workflow"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"","summary":"Update a workflow","parameters":["d1ab15d2-2816-49b6-b642-128dc800a093"],"requestBody":"1cfa243a-5390-4d9b-8e55-a73cb7c98a82","responses":{"200":"8af7c9c0-1e77-4e7e-bc4f-cd005462ebbf","401":"25aee863-c3ad-40d4-87b5-e5804c07e1be","403":"75269983-eb0d-447c-b70f-4db783bddd9c","404":"b6f5643d-acba-47ac-880a-005981fbb27b","429":"747bfb30-daf1-4cae-9152-da592ac85128","500":"cd458609-cf26-4e47-ba35-9c6a25489e62","503":"ff8b2377-4d89-49b3-a4d7-d317b38d75a2"},"tags":["Workflows"],"method":"patch","type":"path","servers":["d8f9567e-b3ab-4227-9ff3-84792ae6b2b5"],"security":["c89e754d-6339-423b-98c3-8ab62097ad71"],"path":"/api/v1/workflows/{workflowUniqueIdentifier}","baseUrlOptions":["https://workflow-app.thena.ai"],"title":"Update a workflow","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"d1ab15d2-2816-49b6-b642-128dc800a093":{"name":"workflowUniqueIdentifier","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"annotations":{"description":"The annotation for the workflow. It is used to pre-populate data from FK relations of the event data which can be used in filters and execution of the workflow.","example":[{"entityType":"Ticket","requiredFields":{"ticketId":"{{context.event.message.payload.ticketId}}"},"relations":["account","account.classification"],"pathToAnnotate":"context.event.message.payload.ticket"}],"type":"array","items":{"type":"string","uniqueKey":"annotations.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"annotations","typeLabel":"string[]"},"name":{"type":"string","description":"The name of the workflow","uniqueKey":"name","typeLabel":"string"},"triggerEvent":{"type":"string","description":"The event that triggers the workflow (Accepts event UID)","uniqueKey":"triggerEvent","typeLabel":"string"},"filters":{"type":"object","description":"Filters to applied on an event attribute to determine when the workflow should trigger. Supports:\n\n Comparison Operators:\n - ~eq: Exact match (any type)\n - ~gte: Greater than or equal (numbers)\n - ~lte: Less than or equal (numbers)\n - ~in: Check if value is in array\n\n String Operators:\n - ~starts: String starts with\n - ~ends: String ends with\n - ~contains: String contains\n - ~regex: Regular expression match\n\n Logical Operators:\n - ~and: All conditions must match\n - ~or: Any condition must match\n\n Example:\n { \"{{context.name}}\": { \"~starts\": \"T\" } }\n ","example":{"{{context.name}}":{"~starts":"T"}},"uniqueKey":"filters","typeLabel":"object"},"workflowDefinition":{"description":"The definition of the workflow","type":"array","items":{"type":"object","properties":{"activity":{"type":"object","description":"The activity of the step (Accepts activity UID)","required":["uniqueIdentifier"],"properties":{"uniqueIdentifier":{"type":"string","description":"The unique identifier of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity.uniqueIdentifier","typeLabel":"string"},"autoUpgradeToLatestVersion":{"type":"boolean","description":"Indicates if the activity should auto upgrade to latest version, takes default of true","uniqueKey":"workflowDefinition.items.[INDEX].activity.autoUpgradeToLatestVersion","typeLabel":"boolean"},"version":{"type":"number","description":"The version of the activity, required when autoUpgradeToLatestVersion is false","uniqueKey":"workflowDefinition.items.[INDEX].activity.version","typeLabel":"number"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity","typeLabel":"object"},"input":{"type":"object","description":"The input for the step","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].input","typeLabel":"object"},"retryPolicy":{"type":"object","description":"The retry policy for the step","properties":{"maximumAttempts":{"type":"number","description":"Max retry count. (Takes default of 3)","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.maximumAttempts","typeLabel":"number"},"initialInterval":{"type":"number","description":"Initial retry interval in seconds. (Takes default of 5s)","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.initialInterval","typeLabel":"number"},"backoffCoefficient":{"type":"number","description":"Retry backoff. (Takes default of 1.5)","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.backoffCoefficient","typeLabel":"number"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy","typeLabel":"object"},"stepIdentifier":{"type":"number","description":"The step identifier of the step (Should be unique across steps) Auto incremented if not provided","uniqueKey":"workflowDefinition.items.[INDEX].stepIdentifier","typeLabel":"number"},"onFailure":{"type":"string","description":"Behavior on failure (if retry policy is specified, this will be applicable post retry policy) (Takes default of ABORT)","enum":["ABORT","CONTINUE","COMPENSATE"],"uniqueKey":"workflowDefinition.items.[INDEX].onFailure","typeLabel":"enum\u003cstring>"},"executionTimeout":{"type":"number","description":"Execution timeout in seconds (Takes default of 5s)","uniqueKey":"workflowDefinition.items.[INDEX].executionTimeout","typeLabel":"number"},"isSleepActivity":{"type":"boolean","description":"Indicates if the activity is for sleeping","uniqueKey":"workflowDefinition.items.[INDEX].isSleepActivity","typeLabel":"boolean"},"dependencies":{"description":"The dependencies for the step (Accepts step UID). Please note that, activities can run in parallel only if they are independent of each other","type":"array","items":{"type":"string","uniqueKey":"workflowDefinition.items.[INDEX].dependencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"workflowDefinition.items.[INDEX].dependencies","typeLabel":"string[]"},"requireApproval":{"type":"boolean","description":"Is an approval required for this step (Takes default of false)","uniqueKey":"workflowDefinition.items.[INDEX].requireApproval","typeLabel":"boolean"},"approver":{"type":"object","description":"The approver (Takes user UID or organization UID)","uniqueKey":"workflowDefinition.items.[INDEX].approver","typeLabel":"object"},"filters":{"type":"object","description":"The filters for the step","uniqueKey":"workflowDefinition.items.[INDEX].filters","typeLabel":"object"},"compensationActivity":{"type":"object","description":"The compensation activity for the step","required":["activity","input"],"properties":{"activity":{"type":"object","description":"The compensation activity","required":["uniqueIdentifier"],"properties":{"uniqueIdentifier":{"type":"string","description":"The unique identifier of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity.activity.uniqueIdentifier","typeLabel":"string"},"autoUpgradeToLatestVersion":{"type":"boolean","description":"Indicates if the activity should auto upgrade to latest version, takes default of true","uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity.activity.autoUpgradeToLatestVersion","typeLabel":"boolean"},"version":{"type":"number","description":"The version of the activity, required when autoUpgradeToLatestVersion is false","uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity.activity.version","typeLabel":"number"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity.activity","typeLabel":"object"},"input":{"type":"object","description":"The input for the compensation activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity.input","typeLabel":"object"}},"uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity","typeLabel":"object"}},"required":["activity","input","retryPolicy"],"uniqueKey":"workflowDefinition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"workflowDefinition","typeLabel":"object[]"},"executingAgent":{"type":"string","description":"The agent on behalf of which the workflow is executed","uniqueKey":"executingAgent","typeLabel":"string"},"teamId":{"type":"string","description":"Provide team id if the visibility and execution of the workflow is to be team specific","uniqueKey":"teamId","typeLabel":"string"},"metadata":{"type":"object","description":"The metadata for the workflow","uniqueKey":"metadata","typeLabel":"object"}},"required":["annotations"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"annotations":[{"entityType":"Ticket","requiredFields":{"ticketId":"{{context.event.message.payload.ticketId}}"},"relations":["account","account.classification"],"pathToAnnotate":"context.event.message.payload.ticket"}],"name":"\u003cstring>","triggerEvent":"\u003cstring>","filters":{"{{context.name}}":{"~starts":"T"}},"workflowDefinition":[{"activity":{"uniqueIdentifier":"\u003cstring>","autoUpgradeToLatestVersion":true,"version":123},"input":{},"retryPolicy":{"maximumAttempts":123,"initialInterval":123,"backoffCoefficient":123},"stepIdentifier":123,"executionTimeout":123,"isSleepActivity":true,"dependencies":["\u003cstring>"],"requireApproval":true,"approver":{},"filters":{}}],"executingAgent":"\u003cstring>","teamId":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8af7c9c0-1e77-4e7e-bc4f-cd005462ebbf":{"description":"Operation successful","content":{"application/json":{"schema":{"type":"object","properties":{"uid":{"type":"string","description":"The identifier for current version of the workflow","isRequired":true,"uniqueKey":"uid","typeLabel":"string"},"type":{"type":"string","description":"The type of the activity","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"subType":{"type":"string","description":"The sub type of the activity","isRequired":true,"uniqueKey":"subType","typeLabel":"string"},"uniqueIdentifier":{"type":"string","description":"The unique identifier of the workflow","isRequired":true,"uniqueKey":"uniqueIdentifier","typeLabel":"string"},"name":{"type":"string","description":"The name identifier of the workflow","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"version":{"type":"number","description":"The version of the workflow","isRequired":true,"uniqueKey":"version","typeLabel":"number"},"triggerEvent":{"type":"object","description":"The trigger event of the workflow","required":["uid","description","eventName","source","schema","metadata"],"properties":{"uid":{"type":"string","description":"The unique identifier of the event","isRequired":true,"uniqueKey":"triggerEvent.uid","typeLabel":"string"},"description":{"type":"string","description":"The description of the event","isRequired":true,"uniqueKey":"triggerEvent.description","typeLabel":"string"},"eventName":{"type":"string","description":"The name of the event","isRequired":true,"uniqueKey":"triggerEvent.eventName","typeLabel":"string"},"source":{"type":"string","description":"The source of the event","enum":["platform_app","registered_app"],"isRequired":true,"uniqueKey":"triggerEvent.source","typeLabel":"enum\u003cstring>"},"schema":{"type":"object","description":"The request schema of the event","isRequired":true,"uniqueKey":"triggerEvent.schema","typeLabel":"object"},"metadata":{"type":"object","description":"The metadata of the event","isRequired":true,"uniqueKey":"triggerEvent.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"triggerEvent","typeLabel":"object"},"filters":{"type":"object","description":"The filters of the workflow","isRequired":true,"uniqueKey":"filters","typeLabel":"object"},"annotations":{"description":"The annotation for the workflow","type":"array","items":{"type":"string","uniqueKey":"annotations.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"annotations","typeLabel":"string[]"},"workflowDefinition":{"description":"The workflow definition of the workflow","type":"array","items":{"type":"object","properties":{"stepIdentifier":{"type":"number","description":"The step identifier of the workflow step","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].stepIdentifier","typeLabel":"number"},"activity":{"type":"object","description":"The activity of the workflow step","required":["name","uniqueIdentifier","version","autoUpgradeToLatestVersion"],"properties":{"name":{"type":"string","description":"The name of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity.name","typeLabel":"string"},"uniqueIdentifier":{"type":"string","description":"The unique identifier of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity.uniqueIdentifier","typeLabel":"string"},"version":{"type":"number","description":"The version of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity.version","typeLabel":"number"},"autoUpgradeToLatestVersion":{"type":"boolean","description":"The auto upgrade to latest version of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity.autoUpgradeToLatestVersion","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].activity","typeLabel":"object"},"input":{"type":"object","description":"The input to the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].input","typeLabel":"object"},"retryPolicy":{"type":"object","properties":{"maximumAttempts":{"type":"number","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.maximumAttempts","typeLabel":"number"},"initialInterval":{"type":"number","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.initialInterval","typeLabel":"number"},"backoffCoefficient":{"type":"number","uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy.backoffCoefficient","typeLabel":"number"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].retryPolicy","typeLabel":"object"},"onFailure":{"type":"string","description":"The action to take on failure of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].onFailure","typeLabel":"string"},"isSleepActivity":{"type":"boolean","description":"Whether the activity is a sleep activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].isSleepActivity","typeLabel":"boolean"},"executionTimeout":{"type":"number","description":"The execution timeout of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].executionTimeout","typeLabel":"number"},"approver":{"type":"object","properties":{"type":{"type":"string","enum":["TEAM","USER"],"uniqueKey":"workflowDefinition.items.[INDEX].approver.type","typeLabel":"enum\u003cstring>"},"uid":{"type":"string","uniqueKey":"workflowDefinition.items.[INDEX].approver.uid","typeLabel":"string"},"timeout":{"type":"number","uniqueKey":"workflowDefinition.items.[INDEX].approver.timeout","typeLabel":"number"}},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].approver","typeLabel":"object"},"dependencies":{"description":"The dependencies of the activity","type":"array","items":{"type":"string","uniqueKey":"workflowDefinition.items.[INDEX].dependencies.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].dependencies","typeLabel":"string[]"},"filters":{"type":"object","description":"The filters of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].filters","typeLabel":"object"},"compensationActivity":{"type":"object","description":"The compensation activity of the activity","isRequired":true,"uniqueKey":"workflowDefinition.items.[INDEX].compensationActivity","typeLabel":"object"}},"required":["stepIdentifier","activity","input","retryPolicy","onFailure","isSleepActivity","executionTimeout","approver","dependencies","filters","compensationActivity"],"uniqueKey":"workflowDefinition.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"workflowDefinition","typeLabel":"object[]"},"executingAgent":{"type":"string","description":"The executing agent of the workflow","isRequired":true,"uniqueKey":"executingAgent","typeLabel":"string"},"isActive":{"type":"boolean","description":"The status of the workflow","isRequired":true,"uniqueKey":"isActive","typeLabel":"boolean"},"createdAt":{"format":"date-time","type":"string","description":"The created at date of the workflow","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"The updated at date of the workflow","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The created by of the workflow","isRequired":true,"uniqueKey":"createdBy","typeLabel":"string"},"teamId":{"type":"string","description":"The team id of the workflow","isRequired":true,"uniqueKey":"teamId","typeLabel":"string"},"metadata":{"type":"object","description":"The metadata for the workflow","isRequired":true,"uniqueKey":"metadata","typeLabel":"object"}},"required":["uid","type","subType","uniqueIdentifier","name","version","triggerEvent","filters","annotations","workflowDefinition","executingAgent","isActive","createdAt","updatedAt","createdBy","teamId","metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"uid":"\u003cstring>","type":"\u003cstring>","subType":"\u003cstring>","uniqueIdentifier":"\u003cstring>","name":"\u003cstring>","version":123,"triggerEvent":{"uid":"\u003cstring>","description":"\u003cstring>","eventName":"\u003cstring>","source":"platform_app","schema":{},"metadata":{}},"filters":{},"annotations":["\u003cstring>"],"workflowDefinition":[{"stepIdentifier":123,"activity":{"name":"\u003cstring>","uniqueIdentifier":"\u003cstring>","version":123,"autoUpgradeToLatestVersion":true},"input":{},"retryPolicy":{"maximumAttempts":123,"initialInterval":123,"backoffCoefficient":123},"onFailure":"\u003cstring>","isSleepActivity":true,"executionTimeout":123,"approver":{"type":"TEAM","uid":"\u003cstring>","timeout":123},"dependencies":["\u003cstring>"],"filters":{},"compensationActivity":{}}],"executingAgent":"\u003cstring>","isActive":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","createdBy":"\u003cstring>","teamId":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"25aee863-c3ad-40d4-87b5-e5804c07e1be":{"description":"User is not authenticated!","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"75269983-eb0d-447c-b70f-4db783bddd9c":{"description":"User does not have access to this resource!","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b6f5643d-acba-47ac-880a-005981fbb27b":{"description":"Resource not found!","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"747bfb30-daf1-4cae-9152-da592ac85128":{"description":"Too many requests!","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"cd458609-cf26-4e47-ba35-9c6a25489e62":{"description":"Something went wrong!","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ff8b2377-4d89-49b3-a4d7-d317b38d75a2":{"description":"This service/resource is currently unavailable.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"c89e754d-6339-423b-98c3-8ab62097ad71":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Enter your API key ","scopes":[]}}},"servers":{"d8f9567e-b3ab-4227-9ff3-84792ae6b2b5":{"url":"https://workflow-app.thena.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Enter your API key ","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"Enter your API key ","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/specs/workflows-openapi.yaml"},"subdomain":"thena-840ce5ec","siteName":"Thena AI","title":"Update a workflow - Thena AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T09:10:05.363Z","originalFileLocation":"api-reference/workflows/workflows/update-a-workflow.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Thena AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a workflow - Thena AI\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Thena AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://thena-840ce5ec.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Update+a+workflow\u0026amp;theme=a199cf38148c3c296b6fdcc7\u0026amp;signature=bfcdbf98600c6964e2cc7f25bf29a8b7bc77947bac40f44dbca81f101ab1aeaa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a workflow - Thena AI\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://thena-840ce5ec.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Update+a+workflow\u0026amp;theme=a199cf38148c3c296b6fdcc7\u0026amp;signature=bfcdbf98600c6964e2cc7f25bf29a8b7bc77947bac40f44dbca81f101ab1aeaa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/thena-840ce5ec/sHJ6Z8DlnV51zxjJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Thena AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6A00FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workflows/workflows/update-a-workflow.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.thena.ai/#organization\",\"name\":\"Thena AI\",\"url\":\"https://docs.thena.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/thena-840ce5ec/fnPhXvYfm-TNmZho/images/docs/Thena-logo.svg?fit=max\u0026auto=format\u0026n=fnPhXvYfm-TNmZho\u0026q=85\u0026s=0536e8ca25c4edb9de80cf3e5bc66b66\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.thena.ai#website\",\"name\":\"Thena AI\",\"url\":\"https://docs.thena.ai\",\"publisher\":{\"@id\":\"https://docs.thena.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow#webpage\",\"url\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow\",\"name\":\"Update a workflow\",\"dateModified\":\"2025-08-07T09:10:05.363Z\",\"isPartOf\":{\"@id\":\"https://docs.thena.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflows\",\"item\":\"https://docs.thena.ai/api-reference/workflows/workflows/available-filter-operators-and-logical-operators-to-use-in-workflow-filters\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows\",\"item\":\"https://docs.thena.ai/api-reference/workflows/workflows/available-filter-operators-and-logical-operators-to-use-in-workflow-filters\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a workflow\",\"item\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow#apireference\",\"headline\":\"Update a workflow\",\"name\":\"Update a workflow\",\"url\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow\",\"mainEntityOfPage\":{\"@id\":\"https://docs.thena.ai/api-reference/workflows/workflows/update-a-workflow#webpage\"},\"dateModified\":\"2025-08-07T09:10:05.363Z\",\"publisher\":{\"@id\":\"https://docs.thena.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.thena.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Thena AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Thena AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/workflows/workflows/update-a-workflow.md","siteName":"Thena AI","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/onboarding/introduction"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/platform/getting-started"}]},{"tab":"API reference","groups":[{"group":"API reference","icon":"book","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Thena MCP server","href":"/api-reference/thena-mcp-server"}]},{"group":"MCP tools","pages":[{"group":"Accounts","pages":[{"title":"Introduction","href":"/api-reference/mcp/accounts/overview"},{"title":"Create account","href":"/api-reference/mcp/accounts/create-account"},{"title":"Create bulk customer contacts","href":"/api-reference/mcp/accounts/create-bulk-customer-contacts"},{"title":"Delete account","href":"/api-reference/mcp/accounts/delete-account"},{"title":"Filter accounts by IDs","href":"/api-reference/mcp/accounts/filter-accounts-by-ids"},{"title":"Filter accounts by primary domains","href":"/api-reference/mcp/accounts/filter-accounts-by-primary-domains"},{"title":"Filter customer contacts by IDs","href":"/api-reference/mcp/accounts/filter-customer-contacts-by-ids"},{"title":"Get account","href":"/api-reference/mcp/accounts/get-account"},{"title":"Get account activity","href":"/api-reference/mcp/accounts/get-account-activity"},{"title":"Get account note","href":"/api-reference/mcp/accounts/get-account-note"},{"title":"Get all account activities","href":"/api-reference/mcp/accounts/get-all-account-activities"},{"title":"Get all account notes","href":"/api-reference/mcp/accounts/get-all-account-notes"},{"title":"Get all accounts","href":"/api-reference/mcp/accounts/get-all-accounts"},{"title":"Get all customer contacts","href":"/api-reference/mcp/accounts/get-all-customer-contacts"},{"title":"Get customer contact","href":"/api-reference/mcp/accounts/get-customer-contact"},{"title":"Search customer contacts","href":"/api-reference/mcp/accounts/search-customer-contacts"},{"title":"Update account","href":"/api-reference/mcp/accounts/update-account"}]},{"group":"Comments","pages":[{"title":"Introduction","href":"/api-reference/mcp/comments/overview"},{"title":"Create comment","href":"/api-reference/mcp/comments/create-comment"},{"title":"Create note","href":"/api-reference/mcp/comments/create-note"},{"title":"Get comments by user type","href":"/api-reference/mcp/comments/get-comments-by-user-type"},{"title":"Get comments on entity","href":"/api-reference/mcp/comments/get-comments-on-entity"},{"title":"Search comments","href":"/api-reference/mcp/comments/search-comments"},{"title":"Update comment","href":"/api-reference/mcp/comments/update-comment"}]},{"group":"Teams","pages":[{"title":"Introduction","href":"/api-reference/mcp/teams/overview"},{"title":"Create team routing rule","href":"/api-reference/mcp/teams/create-team-routing-rule"},{"title":"Get subteams","href":"/api-reference/mcp/teams/get-subteams"},{"title":"Get team configurations","href":"/api-reference/mcp/teams/get-team-configurations"},{"title":"Get team routing rules","href":"/api-reference/mcp/teams/get-team-routing-rules"},{"title":"Search teams","href":"/api-reference/mcp/teams/search-teams"},{"title":"Update team configurations","href":"/api-reference/mcp/teams/update-team-configurations"},{"title":"Update team routing rule","href":"/api-reference/mcp/teams/update-team-routing-rule"}]},{"group":"Tickets","pages":[{"title":"Introduction","href":"/api-reference/mcp/tickets/overview"},{"title":"Assign ticket","href":"/api-reference/mcp/tickets/assign-ticket"},{"title":"Create ticket","href":"/api-reference/mcp/tickets/create-ticket"},{"title":"Create ticket comment","href":"/api-reference/mcp/tickets/create-ticket-comment"},{"title":"Get ticket comments","href":"/api-reference/mcp/tickets/get-ticket-comments"},{"title":"Get ticket priorities","href":"/api-reference/mcp/tickets/get-ticket-priorities"},{"title":"Get ticket statuses","href":"/api-reference/mcp/tickets/get-ticket-statuses"},{"title":"Search tickets","href":"/api-reference/mcp/tickets/search-tickets"},{"title":"Update ticket","href":"/api-reference/mcp/tickets/update-ticket"},{"title":"Update ticket priority","href":"/api-reference/mcp/tickets/update-ticket-priority"},{"title":"Update ticket status","href":"/api-reference/mcp/tickets/update-ticket-status"},{"title":"Get tickets analytics by account","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-account"},{"title":"Get tickets analytics by assignee","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-assignee"},{"title":"Get tickets analytics by custom fields","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-custom-fields"},{"title":"Get tickets analytics by standard fields","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-standard-fields"},{"title":"Get tickets analytics by status","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-status"},{"title":"Get tickets analytics by time","href":"/api-reference/mcp/tickets/get-tickets-analytics-by-time"}]},{"group":"Workflows","pages":[{"title":"Introduction","href":"/api-reference/mcp/workflows/overview"},{"title":"Create workflow","href":"/api-reference/mcp/workflows/create-workflow"},{"title":"Delete workflow","href":"/api-reference/mcp/workflows/delete-workflow"},{"title":"Get activity registry","href":"/api-reference/mcp/workflows/get-activity-registry"},{"title":"Get all workflows","href":"/api-reference/mcp/workflows/get-all-workflows"},{"title":"Get available workflow filters","href":"/api-reference/mcp/workflows/get-available-workflow-filters"},{"title":"Get event registry","href":"/api-reference/mcp/workflows/get-event-registry"},{"title":"Get workflow","href":"/api-reference/mcp/workflows/get-workflow"},{"title":"Get workflow executions","href":"/api-reference/mcp/workflows/get-workflow-executions"},{"title":"Get workflow tasks","href":"/api-reference/mcp/workflows/get-workflow-tasks"},{"title":"Toggle workflow","href":"/api-reference/mcp/workflows/toggle-workflow"},{"title":"Update workflow","href":"/api-reference/mcp/workflows/update-workflow"}]}]},{"group":"Platform","pages":[{"group":"Search","pages":[{"title":null,"href":"/api-reference/search/introduction"},{"title":null,"href":"/api-reference/search/tickets-search"},{"title":null,"href":"/api-reference/search/accounts-search"},{"title":null,"href":"/api-reference/search/organization-search"},{"title":null,"href":"/api-reference/search/users-search"},{"title":null,"href":"/api-reference/search/teams-search"},{"title":null,"href":"/api-reference/search/comments-search"},{"openapi":"get /v1/search/{collection}","title":"Entity search","href":"/api-reference/platform/search/entity-search"},{"openapi":"post /v1/search/multi","title":"Multi search","href":"/api-reference/platform/search/federated-search"}]},{"group":"Users","pages":[{"openapi":"get /v1/users/list","title":"","href":"/api-reference/platform/users/fetch-all-users"},{"openapi":"get /v1/users/details","title":"Fetch current user's details","href":"/api-reference/platform/users/fetch-current-users-details"},{"openapi":"patch /v1/users","title":"Update your user details","href":"/api-reference/platform/users/update-your-user-details"},{"openapi":"patch /v1/users/business-hours","title":"Update your working hours!","href":"/api-reference/platform/users/update-your-working-hours"},{"openapi":"patch /v1/users/availability","title":"Update your availability","href":"/api-reference/platform/users/update-your-availability"},{"openapi":"get /v1/users/time-off","title":"Get all your time off!","href":"/api-reference/platform/users/get-all-your-time-off"},{"openapi":"post /v1/users/time-off","title":"Create your time off!","href":"/api-reference/platform/users/create-your-time-off"},{"openapi":"patch /v1/users/time-off/{id}","title":"Update your time off!","href":"/api-reference/platform/users/update-your-time-off"},{"openapi":"delete /v1/users/time-off/{id}","title":"Delete your time off!","href":"/api-reference/platform/users/delete-your-time-off"}]},{"group":"Teams","pages":[{"openapi":"get /v1/teams","title":"Get all teams that user is the part of!","href":"/api-reference/platform/teams/get-all-teams-that-user-is-the-part-of!"},{"openapi":"post /v1/teams","title":"Create a team","href":"/api-reference/platform/teams/create-a-team"},{"openapi":"get /v1/teams/public","title":"Get all public teams","href":"/api-reference/platform/teams/get-all-public-teams"},{"openapi":"get /v1/teams/{teamId}","title":"Get a team by ID","href":"/api-reference/platform/teams/get-a-team-by-id"},{"openapi":"delete /v1/teams/{teamId}","title":"Delete a team","href":"/api-reference/platform/teams/delete-a-team"},{"openapi":"patch /v1/teams/{teamId}","title":"Update a team","href":"/api-reference/platform/teams/update-a-team"},{"openapi":"get /v1/teams/{teamId}/sub-teams","title":"","href":"/api-reference/platform/teams/get-sub-teams-for-a-team"},{"openapi":"get /v1/teams/{teamId}/members","title":"Get all team members","href":"/api-reference/platform/teams/get-all-team-members"},{"openapi":"post /v1/teams/{teamId}/members","title":"Add a team member","href":"/api-reference/platform/teams/add-a-team-member"},{"openapi":"delete /v1/teams/{teamId}/members/{memberId}","title":"Remove a team member","href":"/api-reference/platform/teams/remove-a-team-member"},{"openapi":"get /v1/teams/{teamId}/configurations","title":"Get team configurations","href":"/api-reference/platform/teams/get-team-configurations"},{"openapi":"patch /v1/teams/{teamId}/configurations","title":"Update team configurations","href":"/api-reference/platform/teams/update-team-configurations"},{"openapi":"get /v1/teams/{teamId}/routing","title":"Get team routing","href":"/api-reference/platform/teams/get-team-routing"},{"openapi":"post /v1/teams/{teamId}/routing","title":"Create a team routing rule","href":"/api-reference/platform/teams/create-a-team-routing-rule"},{"openapi":"delete /v1/teams/{teamId}/routing/{ruleId}","title":null,"href":"/api-reference/platform/teams/delete-a-team-routing-rule"},{"openapi":"patch /v1/teams/{teamId}/routing/{ruleId}","title":"Update team routing","href":"/api-reference/platform/teams/update-team-routing"}]},{"group":"Tickets","pages":[{"openapi":"get /v1/tickets","title":"Get all tickets","href":"/api-reference/platform/tickets/get-all-tickets"},{"openapi":"post /v1/tickets","title":"Create a ticket","href":"/api-reference/platform/tickets/create-a-ticket"},{"openapi":"post /v1/tickets/bulk","title":"Create tickets in bulk","href":"/api-reference/platform/tickets/create-tickets-in-bulk"},{"openapi":"get /v1/tickets/{id}","title":"Get a ticket","href":"/api-reference/platform/tickets/get-a-ticket"},{"openapi":"patch /v1/tickets/{id}","title":"Update a ticket","href":"/api-reference/platform/tickets/update-a-ticket"},{"openapi":"patch /v1/tickets/bulk","title":"Update tickets in bulk","href":"/api-reference/platform/tickets/update-tickets-in-bulk"},{"openapi":"delete /v1/tickets/{id}","title":"Delete a ticket","href":"/api-reference/platform/tickets/delete-a-ticket"},{"openapi":"post /v1/tickets/bulk/bulk-delete","title":"Delete tickets in bulk","href":"/api-reference/platform/tickets/delete-tickets-in-bulk"},{"openapi":"patch /v1/tickets/{id}/assign","title":"Assign a ticket to an agent","href":"/api-reference/platform/tickets/assign-a-ticket-to-an-agent"},{"openapi":"patch /v1/tickets/{id}/reassign-team","title":"Reassign a ticket to a team","href":"/api-reference/platform/tickets/reassign-a-ticket-to-a-team"},{"openapi":"get /v1/tickets/{id}/related","title":"Get ticket related","href":"/api-reference/platform/tickets/get-ticket-related"},{"openapi":"post /v1/tickets/{id}/comment","title":"Comment on a ticket","href":"/api-reference/platform/tickets/comment-on-a-ticket"},{"openapi":"get /v1/tickets/{id}/comments","title":"Get comments for a ticket","href":"/api-reference/platform/tickets/get-comments-for-a-ticket"},{"title":"Get comments for a ticket by user type","href":"/api-reference/platform/tickets/get-comments-for-a-ticket-by-user-type"},{"title":"Attach a file to a ticket","href":"/api-reference/platform/tickets/attach-a-file-to-a-ticket"},{"title":"Get v1tickets attachments","href":"/api-reference/platform/tickets/get-v1tickets-attachments"},{"openapi":"post /v1/tickets/status","title":"Create a new ticket status","href":"/api-reference/platform/tickets/create-a-new-ticket-status"},{"openapi":"get /v1/tickets/status","title":"Get all ticket statuses","href":"/api-reference/platform/tickets/get-all-ticket-statuses"},{"openapi":"get /v1/tickets/status/{id}","title":"Get a ticket status by its ID","href":"/api-reference/platform/tickets/get-a-ticket-status-by-its-id"},{"openapi":"patch /v1/tickets/status/{id}","title":"Update a ticket status","href":"/api-reference/platform/tickets/update-a-ticket-status"},{"openapi":"delete /v1/tickets/status/{id}","title":"Delete a custom ticket status","href":"/api-reference/platform/tickets/delete-a-custom-ticket-status"},{"openapi":"patch /v1/tickets/{id}/unarchive","title":"","href":"/api-reference/platform/tickets/unarchive-a-ticket"},{"openapi":"patch /v1/tickets/{id}/archive","title":"Archive a ticket","href":"/api-reference/platform/tickets/archive-a-ticket"},{"openapi":"patch /v1/tickets/bulk/archive","title":"Archive tickets in bulk","href":"/api-reference/platform/tickets/archive-tickets-in-bulk"}]},{"group":"Tags","pages":[{"openapi":"get /v1/tags","title":"Get all tags","href":"/api-reference/platform/tags/get-all-tags"},{"openapi":"post /v1/tags","title":"Create a new tag","href":"/api-reference/platform/tags/create-a-new-tag"},{"openapi":"get /v1/tags/{tagId}","title":"Get a specific tag","href":"/api-reference/platform/tags/get-a-specific-tag"},{"openapi":"patch /v1/tags/{tagId}","title":"Update a tag","href":"/api-reference/platform/tags/update-a-tag"},{"openapi":"delete /v1/tags/{tagId}","title":"Delete a tag","href":"/api-reference/platform/tags/delete-a-tag"},{"openapi":"get /v1/teams/{teamUuid}/tags","title":"Get all tags for a particular team","href":"/api-reference/platform/tags/get-all-tags-for-a-particular-team"},{"openapi":"post /v1/teams/{teamUuid}/tags","title":"Create a new tag for a particular team","href":"/api-reference/platform/tags/create-a-new-tag-for-a-particular-team"},{"openapi":"put /v1/teams/{teamUuid}/tags/{tagUuid}","title":"Update a tag for a particular team","href":"/api-reference/platform/tags/update-a-tag-for-a-particular-team"},{"openapi":"delete /v1/teams/{teamUuid}/tags/{tagUuid}","title":"Remove a tag from a particular team","href":"/api-reference/platform/tags/remove-a-tag-from-a-particular-team"}]},{"group":"Ticket tags","pages":[{"openapi":"get /v1/tickets/{ticketId}/tags","title":"Get all tags for a ticket","href":"/api-reference/platform/ticket-tags/get-all-tags-for-a-ticket"},{"openapi":"post /v1/tickets/{ticketId}/tags","title":"Tags successfully added to ticket","href":"/api-reference/platform/ticket-tags/tags-successfully-added-to-ticket"},{"openapi":"delete /v1/tickets/{ticketId}/tags/{tagId}","title":"Remove a tag from a ticket","href":"/api-reference/platform/ticket-tags/remove-a-tag-from-a-ticket"}]},{"group":"Accounts","pages":[{"openapi":"get /v1/accounts/{id}","title":"Get account details","href":"/api-reference/platform/accounts/get-account-details"},{"openapi":"post /v1/accounts/filter/ids","title":"","href":"/api-reference/platform/accounts/get-accounts-by-ids"},{"openapi":"post /v1/accounts","title":"Create an account","href":"/api-reference/platform/accounts/create-an-account"},{"openapi":"put /v1/accounts/{id}","title":"Update an account","href":"/api-reference/platform/accounts/update-an-account"},{"openapi":"delete /v1/accounts/{id}","title":"Delete an account","href":"/api-reference/platform/accounts/delete-an-account"},{"openapi":"post /v1/accounts/contacts","title":"Create an account contact","href":"/api-reference/platform/accounts/create-a-customer-contact"},{"openapi":"post /v1/accounts/contacts/filter/ids","title":"Filter customer contacts by IDs","href":"/api-reference/platform/accounts/filter-customer-contacts-by-ids"},{"openapi":"post /v1/accounts/contacts/bulk","title":"Bulk create account contacts","href":"/api-reference/platform/accounts/bulk-create-customer-contacts"},{"openapi":"put /v1/accounts/contacts/{contactId}","title":"Update customer contact","href":"/api-reference/platform/accounts/update-a-customer-contact"},{"openapi":"delete /v1/accounts/contacts/{contactId}","title":"Delete customer contact","href":"/api-reference/platform/accounts/delete-a-customer-contact"},{"openapi":"get /v1/accounts/attributes","title":"Gets all account attribute values","href":"/api-reference/platform/accounts/gets-all-account-attribute-values"},{"openapi":"get /v1/accounts/activities","title":"Fetches all account activities","href":"/api-reference/platform/accounts/fetches-all-account-activities"},{"openapi":"post /v1/accounts/activities","title":"Creates an account activity","href":"/api-reference/platform/accounts/creates-an-account-activity"},{"openapi":"put /v1/accounts/activities/{activityId}","title":"Updates an account activity","href":"/api-reference/platform/accounts/updates-an-account-activity"},{"openapi":"delete /v1/accounts/activities/{activityId}","title":"Deletes an account activity","href":"/api-reference/platform/accounts/deletes-an-account-activity"},{"openapi":"delete /v1/accounts/activities/{activityId}/attachments/{attachmentId}","title":"Removes an attachment from an account activity","href":"/api-reference/platform/accounts/removes-an-attachment-from-an-account-activity"},{"openapi":"get /v1/accounts/notes","title":"Fetches all account notes by account ID or by note ID","href":"/api-reference/platform/accounts/fetches-all-account-notes-by-account-id-or-by-note-id"},{"openapi":"post /v1/accounts/notes","title":"Creates an account note","href":"/api-reference/platform/accounts/creates-an-account-note"},{"openapi":"put /v1/accounts/notes/{noteId}","title":"Updates an account note","href":"/api-reference/platform/accounts/updates-an-account-note"},{"openapi":"delete /v1/accounts/notes/{noteId}","title":"Deletes an account note","href":"/api-reference/platform/accounts/deletes-an-account-note"},{"openapi":"delete /v1/accounts/notes/{noteId}/attachments/{attachmentId}","title":"Removes an attachment from an account note","href":"/api-reference/platform/accounts/removes-an-attachment-from-an-account-note"},{"openapi":"get /v1/accounts/tasks","title":"Fetches all account tasks by account ID or by task ID","href":"/api-reference/platform/accounts/fetches-all-account-tasks-by-account-id-or-by-task-id"},{"openapi":"post /v1/accounts/tasks","title":"Creates an account task","href":"/api-reference/platform/accounts/creates-an-account-task"},{"openapi":"put /v1/accounts/tasks/{taskId}","title":"Updates an account task","href":"/api-reference/platform/accounts/updates-an-account-task"},{"openapi":"delete /v1/accounts/tasks/{taskId}","title":"Deletes an account task","href":"/api-reference/platform/accounts/deletes-an-account-task"},{"openapi":"delete /v1/accounts/tasks/{taskId}/attachments/{attachmentId}","title":"Removes an attachment from an account task","href":"/api-reference/platform/accounts/removes-an-attachment-from-an-account-task"},{"openapi":"post /v1/accounts/contacts/ingest","title":"Ingest customer contacts","href":"/api-reference/platform/accounts/ingest-users"}]},{"group":"Forms","pages":[{"openapi":"get /v1/forms","title":"Get all forms","href":"/api-reference/platform/forms/get-all-forms"},{"openapi":"post /v1/forms","title":"Create a form","href":"/api-reference/platform/forms/create-a-form"},{"openapi":"patch /v1/forms","title":"Update form","href":"/api-reference/platform/forms/update-form"},{"openapi":"get /v1/forms/fetchByIds","title":"Get forms by IDs","href":"/api-reference/platform/forms/get-forms-by-ids"},{"openapi":"get /v1/forms/search","title":"Search forms using name","href":"/api-reference/platform/forms/search-forms-using-name"},{"openapi":"post /v1/forms/delete","title":"Delete forms","href":"/api-reference/platform/forms/delete-forms"},{"openapi":"post /v1/forms/order","title":"","href":"/api-reference/platform/forms/order-forms"}]},{"group":"Comments","pages":[{"openapi":"get /v1/comments","title":"","href":"/api-reference/platform/comments/get-comments-on-an-entity"},{"openapi":"get /v1/comments/user-type","title":"","href":"/api-reference/platform/comments/get-comments-for-an-entity-by-user-type"},{"openapi":"get /v1/comments/{commentId}/threads","title":"Get comment threads","href":"/api-reference/platform/comments/get-comment-threads"},{"openapi":"get /v1/comments/{commentId}","title":"Get a comment","href":"/api-reference/platform/comments/get-a-comment"},{"openapi":"post /v1/comments","title":"","href":"/api-reference/platform/comments/comment-on-an-entity"},{"openapi":"patch /v1/comments/{commentId}","title":"Update a comment","href":"/api-reference/platform/comments/update-a-comment"},{"openapi":"delete /v1/comments/{commentId}","title":"Delete a comment","href":"/api-reference/platform/comments/delete-a-comment"}]},{"group":"Emoji actions","pages":[{"openapi":"get /v1/emojis/actions","title":"","href":"/api-reference/platform/emoji-actions/get-all-emoji-actions"},{"openapi":"get /v1/emojis/actions/{teamId}","title":"","href":"/api-reference/platform/emoji-actions/get-all-emoji-actions-for-a-team"},{"openapi":"post /v1/emojis/actions/{teamId}","title":"","href":"/api-reference/platform/emoji-actions/map-an-emoji-action"},{"openapi":"patch /v1/emojis/actions/{teamId}","title":"","href":"/api-reference/platform/emoji-actions/update-an-emoji-action"},{"openapi":"patch /v1/emojis/actions/{teamId}/{emojiActionId}","title":"","href":"/api-reference/platform/emoji-actions/update-an-emoji-action-by-id"},{"openapi":"delete /v1/emojis/actions/{teamId}/{emojiActionId}","title":"","href":"/api-reference/platform/emoji-actions/delete-an-emoji-action-by-id"}]},{"group":"Custom fields","pages":[{"openapi":"get /v1/custom-field","title":"Get all custom fields","href":"/api-reference/platform/custom-fields/get-all-custom-fields"},{"openapi":"post /v1/custom-field","title":"Create a custom field","href":"/api-reference/platform/custom-fields/create-a-custom-field"},{"openapi":"patch /v1/custom-field","title":"Update custom fields","href":"/api-reference/platform/custom-fields/update-custom-fields"},{"openapi":"post /v1/custom-field/delete","title":"Delete custom fields","href":"/api-reference/platform/custom-fields/delete-custom-fields"},{"openapi":"get /v1/custom-field/fetchByIds","title":"Get custom fields by IDs","href":"/api-reference/platform/custom-fields/get-custom-fields-by-ids"},{"openapi":"get /v1/custom-field/search","title":"Search custom field using name","href":"/api-reference/platform/custom-fields/search-custom-field-using-name"},{"openapi":"get /v1/custom-field/types","title":"Get all custom field types","href":"/api-reference/platform/custom-fields/get-all-custom-field-types"},{"openapi":"get /v1/custom-field/thena-restricted-fields","title":"","href":"/api-reference/platform/custom-fields/get-all-thena-restricted-fields"}]},{"group":"CSAT","pages":[{"openapi":"post /csat/submissions","title":null,"href":"/api-reference/platform/post-csatsubmissions"},{"openapi":"get /v1/csat/team/{teamUid}","title":"Get CSAT settings by team ID","href":"/api-reference/platform/csat/get-csat-settings-by-team-id"},{"openapi":"get /v1/csat/rules/{id}","title":"Get a CSAT rule by ID","href":"/api-reference/platform/csat/get-a-csat-rule-by-id"},{"openapi":"patch /v1/csat/rules/{id}","title":"Update a CSAT rule","href":"/api-reference/platform/csat/update-a-csat-rule"},{"openapi":"delete /v1/csat/rules/{id}","title":"Delete a CSAT rule","href":"/api-reference/platform/csat/delete-a-csat-rule"},{"openapi":"post /v1/csat/rules/{teamUid}","title":"Create a CSAT rule for a team","href":"/api-reference/platform/csat/create-a-csat-rule-for-a-team"},{"openapi":"patch /v1/csat/team/{teamUid}/update","title":"Update the Csat setting for a team","href":"/api-reference/platform/csat/update-the-csat-setting-for-a-team"},{"openapi":"patch /v1/csat/team/{teamUid}/cooldown","title":null,"href":"/api-reference/platform/csat/update-the-cooldown-period-for-a-team"},{"openapi":"patch /v1/csat/team/{teamUid}/rules/reorder","title":"Reorder the priority of CSAT rules for a team","href":"/api-reference/platform/csat/reorder-the-priority-of-csat-rules-for-a-team"}]},{"group":"Storage","pages":[{"openapi":"post /storage/upload-file","title":"Upload a single file","href":"/api-reference/platform/storage/upload-a-single-file"}]},{"group":"Reactions","pages":[{"openapi":"post /v1/reactions/{commentId}","title":"Add a reaction to a comment","href":"/api-reference/platform/reactions/add-a-reaction-to-a-comment"},{"openapi":"delete /v1/reactions/remove/{commentId}/{reactionName}","title":"Remove a reaction from a comment","href":"/api-reference/platform/reactions/remove-a-reaction-from-a-comment"},{"openapi":"get /v1/reactions/emojis","title":"","href":"/api-reference/platform/reactions/get-v1reactionsemojis"}]}]},{"group":"Agent studio","pages":[{"group":"Agents","pages":[{"openapi":"post /api/v1/agents","title":"Create Agent","href":"/api-reference/agent-studio/agents/create-agent"},{"openapi":"put /api/v1/agents/{agent_id}","title":"Update Agent","href":"/api-reference/agent-studio/agents/update-agent"},{"openapi":"delete /api/v1/agents/{agent_id}","title":"Delete Agent","href":"/api-reference/agent-studio/agents/delete-agent"},{"openapi":"get /api/v1/agents/{agent_id}","title":"Get Agent","href":"/api-reference/agent-studio/agents/get-agent"},{"openapi":"get /api/v1/agents","title":"List Agents","href":"/api-reference/agent-studio/agents/list-agents"}]},{"group":"Chat","pages":[{"openapi":"post /api/v1/chat/{agent_id}/threads/{thread_id}/messages/stream","title":"Add Chat Message Stream","href":"/api-reference/agent-studio/chat/add-chat-message-stream"},{"openapi":"post /api/v1/chat/{agent_id}/threads/{thread_id}/messages","title":"Add Chat Message","href":"/api-reference/agent-studio/chat/add-chat-message"},{"openapi":"delete /api/v1/chat/clear-all-chats","title":"Clear All Chats","href":"/api-reference/agent-studio/chat/clear-all-chats"},{"openapi":"post /api/v1/chat/{agent_id}/threads","title":"Create Chat Thread","href":"/api-reference/agent-studio/chat/create-chat-thread"},{"openapi":"delete /api/v1/chat/{agent_id}/threads/{thread_id}","title":"Delete Chat Thread","href":"/api-reference/agent-studio/chat/delete-chat-thread"},{"openapi":"get /api/v1/chat/history","title":"Get Chat History","href":"/api-reference/agent-studio/chat/get-chat-history"},{"openapi":"get /api/v1/chat/{agent_id}/threads/{thread_id}","title":"Get Chat Thread","href":"/api-reference/agent-studio/chat/get-chat-thread"},{"openapi":"get /api/v1/chat/{agent_id}/recent-thread","title":"Get Recent Thread","href":"/api-reference/agent-studio/chat/get-recent-thread"},{"openapi":"get /api/v1/chat/{agent_id}/threads/{thread_id}/messages","title":"List Chat Messages","href":"/api-reference/agent-studio/chat/list-chat-messages"},{"openapi":"get /api/v1/chat/{agent_id}/web-threads/enhanced","title":"List Enhanced Web Chat Threads","href":"/api-reference/agent-studio/chat/list-enhanced-web-chat-threads"},{"openapi":"get /api/v1/chat/{agent_id}/web-threads","title":"List Web Chat Threads","href":"/api-reference/agent-studio/chat/list-web-chat-threads"},{"openapi":"get /api/v1/chat/{agent_id}/web-threads/search","title":"Search Web Chat Threads","href":"/api-reference/agent-studio/chat/search-web-chat-threads"},{"openapi":"get /api/v1/chat/{agent_id}/threads/{thread_id}/stream","title":"Stream Chat Messages","href":"/api-reference/agent-studio/chat/stream-chat-messages"},{"openapi":"get /api/v1/chat/{agent_id}/threads","title":"List Chat Threads","href":"/api-reference/agent-studio/chat/list-chat-threads"}]},{"group":"Agent tools","pages":[{"openapi":"post /api/v1/agents/{agent_id}/tools","title":"Create Agent Tool","href":"/api-reference/agent-studio/agent-tools/create-agent-tool"},{"openapi":"delete /api/v1/agents/{agent_id}/tools/{tool_id}","title":"Delete Agent Tool","href":"/api-reference/agent-studio/agent-tools/delete-agent-tool"},{"openapi":"get /api/v1/agents/{agent_id}/tools/{tool_id}","title":"Get Agent Tool","href":"/api-reference/agent-studio/agent-tools/get-agent-tool"},{"openapi":"get /api/v1/agents/{agent_id}/tools/{tool_id}/executions","title":"Get Tool Executions","href":"/api-reference/agent-studio/agent-tools/get-tool-executions"},{"openapi":"put /api/v1/agents/{agent_id}/tools/{tool_id}","title":"Update Agent Tool","href":"/api-reference/agent-studio/agent-tools/update-agent-tool"},{"openapi":"get /api/v1/agents/{agent_id}/tools","title":"Get Agent Tools","href":"/api-reference/agent-studio/agent-tools/get-agent-tools"}]},{"group":"Flow execution","pages":[{"openapi":"post /api/v1/flows/executions/bulk","title":"Bulk Execute Flows","href":"/api-reference/agent-studio/flow-execution/bulk-execute-flows"},{"openapi":"post /api/v1/flows/executions/{execution_id}/cancel","title":"Cancel Execution","href":"/api-reference/agent-studio/flow-execution/cancel-execution"},{"openapi":"get /api/v1/flows/analytics","title":"Get Execution Analytics","href":"/api-reference/agent-studio/flow-execution/get-execution-analytics"},{"openapi":"get /api/v1/flows/executions/{execution_id}","title":"Get Execution","href":"/api-reference/agent-studio/flow-execution/get-execution"},{"openapi":"get /api/v1/flows/queue-status","title":"Get Queue Status","href":"/api-reference/agent-studio/flow-execution/get-queue-status"},{"openapi":"get /api/v1/flows/executions","title":"List Executions","href":"/api-reference/agent-studio/flow-execution/list-executions"},{"openapi":"post /api/v1/flows/queue/retry","title":"Retry Failed Jobs","href":"/api-reference/agent-studio/flow-execution/retry-failed-jobs"},{"openapi":"get /api/v1/flows/executions/{execution_id}/stream","title":"Stream Execution Updates","href":"/api-reference/agent-studio/flow-execution/stream-execution-updates"},{"openapi":"patch /api/v1/flows/executions/{execution_id}","title":"Update Execution","href":"/api-reference/agent-studio/flow-execution/update-execution"},{"openapi":"post /api/v1/flows/execute","title":"Execute Flow","href":"/api-reference/agent-studio/flow-execution/execute-flow"}]},{"group":"Agent files","pages":[{"openapi":"post /api/v1/agent-files/{agent_id}/urls","title":"Add Url To Agent","href":"/api-reference/agent-studio/agent-files/add-url-to-agent"},{"openapi":"delete /api/v1/agent-files/{agent_id}/files/{file_id}","title":"Delete Agent File","href":"/api-reference/agent-studio/agent-files/delete-agent-file"},{"openapi":"get /api/v1/agent-files/{agent_id}/files/{file_id}","title":"Get Agent File","href":"/api-reference/agent-studio/agent-files/get-agent-file"},{"openapi":"get /api/v1/agent-files/{agent_id}/files","title":"List Agent Files","href":"/api-reference/agent-studio/agent-files/list-agent-files"},{"openapi":"get /api/v1/agent-files/{agent_id}/files/search","title":"Search Agent Files","href":"/api-reference/agent-studio/agent-files/search-agent-files"},{"openapi":"post /api/v1/agent-files/{agent_id}/files","title":"Upload Agent File","href":"/api-reference/agent-studio/agent-files/upload-agent-file"}]},{"group":"Feedback","pages":[{"openapi":"post /api/v1/feedback/flow","title":"Create Flow Execution Feedback","href":"/api-reference/agent-studio/feedback/create-flow-execution-feedback"},{"openapi":"get /api/v1/feedback/message/{message_id}","title":"Get Chat Message Feedback","href":"/api-reference/agent-studio/feedback/get-chat-message-feedback"},{"openapi":"post /api/v1/feedback/batch-chat","title":"Get Chat Messages Feedback Batch","href":"/api-reference/agent-studio/feedback/get-chat-messages-feedback-batch"},{"openapi":"get /api/v1/feedback/flow-execution/{execution_id}","title":"Get Flow Execution Feedback","href":"/api-reference/agent-studio/feedback/get-flow-execution-feedback"},{"openapi":"post /api/v1/feedback/chat","title":"Create Chat Message Feedback","href":"/api-reference/agent-studio/feedback/create-chat-message-feedback"}]},{"group":"MCP servers","pages":[{"openapi":"post /api/v1/mcp/agents/{agent_id}/servers/{server_id}/health-check","title":"Check Mcp Server Health","href":"/api-reference/agent-studio/mcp-servers/check-mcp-server-health"},{"openapi":"post /api/v1/mcp/agents/{agent_id}/servers/{server_id}/connect","title":"Connect Mcp Server","href":"/api-reference/agent-studio/mcp-servers/connect-mcp-server"},{"openapi":"post /api/v1/mcp/agents/{agent_id}/servers","title":"Create Mcp Server","href":"/api-reference/agent-studio/mcp-servers/create-mcp-server"},{"openapi":"delete /api/v1/mcp/agents/{agent_id}/servers/{server_id}","title":"Delete Mcp Server","href":"/api-reference/agent-studio/mcp-servers/delete-mcp-server"},{"openapi":"get /api/v1/mcp/agents/{agent_id}/servers/{server_id}/tools","title":"Get Mcp Server Tools","href":"/api-reference/agent-studio/mcp-servers/get-mcp-server-tools"},{"openapi":"put /api/v1/mcp/agents/{agent_id}/servers/{server_id}","title":"Update Mcp Server","href":"/api-reference/agent-studio/mcp-servers/update-mcp-server"},{"openapi":"get /api/v1/mcp/agents/{agent_id}/servers","title":"Get Agent Mcp Servers","href":"/api-reference/agent-studio/mcp-servers/get-agent-mcp-servers"}]}]},{"group":"Workflows","pages":[{"group":"Workflows","pages":[{"openapi":"get /api/v1/workflows/registry/filters","title":"Available filter operators and logical operators to use in workflow filters","href":"/api-reference/workflows/workflows/available-filter-operators-and-logical-operators-to-use-in-workflow-filters"},{"openapi":"post /api/v1/workflows","title":"Create a new workflow","href":"/api-reference/workflows/workflows/create-a-new-workflow"},{"openapi":"delete /api/v1/workflows/{workflowUniqueIdentifier}","title":"Delete a workflow","href":"/api-reference/workflows/workflows/delete-a-workflow"},{"openapi":"get /api/v1/workflows/registry/activities","title":"Get activity registry","href":"/api-reference/workflows/workflows/get-activity-registry"},{"openapi":"get /api/v1/workflows/executions","title":"Get all the executions of a workflow","href":"/api-reference/workflows/workflows/get-all-the-executions-of-a-workflow"},{"openapi":"get /api/v1/workflows/{workflowInstanceId}/tasks","title":"Get all the tasks of a workflow execution","href":"/api-reference/workflows/workflows/get-all-the-tasks-of-a-workflow-execution"},{"openapi":"get /api/v1/workflows","title":"Get all the workflows defined by the organization","href":"/api-reference/workflows/workflows/get-all-the-workflows-defined-by-the-organization"},{"openapi":"get /api/v1/workflows/{workflowUniqueIdentifier}","title":"Get all the workflows defined by the organization","href":"/api-reference/workflows/workflows/get-all-the-workflows-defined-by-the-organization-1"},{"openapi":"get /api/v1/workflows/registry/events","title":"Get event registry","href":"/api-reference/workflows/workflows/get-event-registry"},{"openapi":"post /api/v1/workflows/{workflowUniqueIdentifier}/toggle","title":"Toggle a workflow","description":null,"href":"/api-reference/workflows/workflows/toggle-a-workflow"},{"openapi":"patch /api/v1/workflows/{workflowUniqueIdentifier}","title":"Update a workflow","href":"/api-reference/workflows/workflows/update-a-workflow"}]}]},{"group":"SLA","pages":[{"group":"SLA Policies","pages":[{"openapi":"get /v1/sla/policy","title":"Get all policies","description":null,"href":"/api-reference/sla/sla-policies/get-all-policies"},{"openapi":"post /v1/sla/policy","title":"Create a policy","href":"/api-reference/sla/sla-policies/create-a-policy"},{"openapi":"get /v1/sla/policy/{id}","title":"Get a policy","href":"/api-reference/sla/sla-policies/get-a-policy"},{"openapi":"delete /v1/sla/policy/{id}","title":"Archive a policy","href":"/api-reference/sla/sla-policies/archive-a-policy"},{"openapi":"patch /v1/sla/policy/{id}","title":"Update a policy","href":"/api-reference/sla/sla-policies/update-a-policy"},{"openapi":"patch /v1/sla/priorities","title":"Update priorities","href":"/api-reference/sla/sla-policies/update-priorities"},{"openapi":"post /v1/sla/pause","title":"Manually pause SLA for a ticket","href":"/api-reference/sla/sla-policies/manually-pause-sla-for-a-ticket"},{"openapi":"post /v1/sla/resume","title":"Manually resume SLA for a ticket","href":"/api-reference/sla/sla-policies/manually-resume-sla-for-a-ticket"}]},{"group":"SLA Duration","pages":[{"openapi":"get /v1/sla/duration","title":"Get the duration left for a job","href":"/api-reference/sla/sla-duration/get-the-duration-left-for-a-job"},{"openapi":"post /v1/sla/override-sla","title":"Override SLA for a job","href":"/api-reference/sla/sla-duration/override-sla-for-a-job"}]}]},{"group":"Apps platform","pages":[{"group":"App creation","pages":[{"openapi":"post /apps/create-app","title":"Create a new app","href":"/api-reference/apps-platform/app-creation/create-a-new-app"},{"openapi":"delete /apps/{id}/delete-app","title":"Delete an app","href":"/api-reference/apps-platform/app-creation/delete-an-app"},{"openapi":"get /apps/fetch-app-manifest/{id}","title":"Fetch app manifest","href":"/api-reference/apps-platform/app-creation/fetch-app-manifest"},{"openapi":"get /apps/fetch-apps","title":null,"href":"/api-reference/apps-platform/app-creation/get-appsfetch-apps"},{"openapi":"patch /apps/{id}/update-app","title":"Update an existing app","href":"/api-reference/apps-platform/app-creation/update-an-existing-app"}]},{"group":"App installation","pages":[{"openapi":"post /apps/install","title":"Install an app","href":"/api-reference/apps-platform/app-installation/install-an-app"},{"openapi":"get /apps/installed-apps","title":"Get installed apps by organization","href":"/api-reference/apps-platform/app-installation/get-installed-apps-by-organization"},{"openapi":"post /apps/update-config","title":"update the configuration for installations","href":"/api-reference/apps-platform/app-installation/update-the-configuration-for-installations"},{"openapi":"post /apps/add-app-to-teams","title":"add app to teams","href":"/api-reference/apps-platform/app-installation/add-app-to-teams"},{"openapi":"post /apps/remove-app-from-teams","title":"remove app from teams","href":"/api-reference/apps-platform/app-installation/remove-app-from-teams"}]},{"group":"App uninstallation","pages":[{"openapi":"post /apps/uninstall","title":"Uninstall an app","href":"/api-reference/apps-platform/app-uninstallation/post-appsuninstall"}]},{"group":"App reinstallation","pages":[{"openapi":"post /apps/reinstall","title":"Reinstall an app","href":"/api-reference/apps-platform/app-reinstallation/reinstall-an-app"}]},{"group":"Incoming webhook","pages":[{"openapi":"post /incoming-webhook/events","title":"Handle published events webhook","href":"/api-reference/apps-platform/incoming-webhook/handle-published-events-webhook"}]}]},{"group":"Help Center","pages":[{"group":"Help Centers","pages":[{"openapi":"get /help-centers","title":"Get all help centers for the user","href":"/api-reference/thena-help-center/help-centers/get-all-help-centers-for-the-user"},{"openapi":"post /help-centers","title":"Create a new help center","href":"/api-reference/thena-help-center/help-centers/create-a-new-help-center"},{"openapi":"get /help-centers/{helpCenterId}","title":"Get a specific help center by ID","href":"/api-reference/thena-help-center/help-centers/get-a-specific-help-center-by-id"},{"openapi":"delete /help-centers/{helpCenterId}","title":"Delete a help center","href":"/api-reference/thena-help-center/help-centers/delete-a-help-center"},{"openapi":"patch /help-centers/{helpCenterId}","title":"Update a help center","href":"/api-reference/thena-help-center/help-centers/update-a-help-center"},{"openapi":"patch /help-centers/custom-domain/{helpCenterId}","title":"Update custom domain for a help center","href":"/api-reference/thena-help-center/help-centers/update-custom-domain-for-a-help-center"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"Get all collections of an organization","href":"/api-reference/thena-help-center/collection/get-all-collections-of-an-organization"},{"openapi":"post /collections","title":"Create a new collection","href":"/api-reference/thena-help-center/collection/create-a-new-collection"},{"openapi":"get /collections/tree","title":"Get collection tree with articles of a help center","href":"/api-reference/thena-help-center/collection/get-collection-tree-with-articles-of-a-help-center"},{"openapi":"get /collections/{collectionId}","title":"Get a specific collection","href":"/api-reference/thena-help-center/collection/get-a-specific-collection"},{"openapi":"delete /collections/{collectionId}","title":null,"href":"/api-reference/thena-help-center/collection/delete-collections"},{"openapi":"patch /collections/{collectionId}","title":"Update a collection","href":"/api-reference/thena-help-center/collection/update-a-collection"}]},{"group":"Articles","pages":[{"openapi":"get /articles","title":"Get all articles","href":"/api-reference/thena-help-center/article/get-all-articles"},{"openapi":"post /articles","title":"Create a new article","href":"/api-reference/thena-help-center/article/create-a-new-article"},{"openapi":"get /articles/{articleId}","title":"Get article by ID","href":"/api-reference/thena-help-center/article/get-article-by-id"},{"openapi":"delete /articles/{articleId}","title":"Delete article","href":"/api-reference/thena-help-center/article/delete-article"},{"openapi":"patch /articles/{articleId}","title":"Update article","href":"/api-reference/thena-help-center/article/update-article"}]},{"group":"Tags","pages":[{"openapi":"get /tags","title":"Get all tags","href":"/api-reference/thena-help-center/tag/get-all-tags"},{"openapi":"post /tags","title":"Create a new tag","href":"/api-reference/thena-help-center/tag/create-a-new-tag"},{"openapi":"delete /tags/{tagId}","title":"Delete a tag","href":"/api-reference/thena-help-center/tag/delete-a-tag"},{"openapi":"patch /tags/{tagId}","title":"Update a tag","href":"/api-reference/thena-help-center/tag/update-a-tag"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/all"}]}]},"basePath":"","title":"Update a workflow - Thena AI","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}